DirectX SDK

IDirectDrawSurface7::GetUniquenessValue

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

HRESULT GetUniquenessValue( 
  LPDWORD lpValue 
); 

Parameters

lpValue
Address of a variable to 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 it fails, the method can return one of the following error values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

Remarks

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

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in ddraw.h.

See Also

IDirectDrawSurface7::ChangeUniquenessValue, Surface Uniqueness Values