IDirectDrawSurface4::GetUniquenessValue

The IDirectDrawSurface4::GetUniquenessValue method retrieves the current uniqueness value for this surface.

HRESULT GetUniquenessValue( 
  LPDWORD lpValue, 
); 
 

Parameters

lpValue
Address of a variable that will be filled with the surface's current uniqueness value, if the call succeeds.

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_INVALIDOBJECT
DDERR_INVALIDPARAMS

Remarks

The only defined uniqueness value is 0, to indicate that the surface is likely to be changing beyond DirectDraw's control. Other uniqueness values are only significant if they differ from a previously cached uniqueness value. If the current value is different than a cached value, then the contents of the surface have changed.

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::ChangeUniquenessValue, Surface Uniqueness Values