IDirectDrawSurface4::Unlock

The IDirectDrawSurface4::Unlock method notifies DirectDraw that the direct surface manipulations are complete.

HRESULT Unlock(
  LPRECT lpRect 
);
 

Parameters

lpRect
Address of the RECT structure that was used to lock the surface in the corresponding call to the IDirectDrawSurface4::Lock method. This parameter can be NULL only if the entire surface was locked by passing NULL in the lpDestRect parameter of the corresponding call to the IDirectDrawSurface4::Lock method.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDRECT
DDERR_NOTLOCKED
DDERR_SURFACELOST

Remarks

Because it is possible to call IDirectDrawSurface4::Lock multiple times for the same surface with different destination rectangles, the pointer in lpRect links the calls to the IDirectDrawSurface4::Lock and IDirectDrawSurface4::Unlock methods.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirectDrawSurface4::Lock