IDirectDrawSurface4::GetPrivateData

The IDirectDrawSurface4::GetPrivateData method copies the private data associated with the surface to a provided buffer.

HRESULT GetPrivateData(
  REFGUID guidTag,
  LPVOID  lpBuffer,
  LPDWORD lpcbBufferSize
); 
 

Parameters

guidTag

Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to be retrieved.

lpBuffer

Address of a previously allocated buffer that will be filled with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer.

lpcbBufferSize

Size of the buffer at lpBuffer, in bytes. If this value is less than the actual size of the private data (such as zero), the method sets this parameter to the required buffer size, and the method returns DDERR_MOREDATA.

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:

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::SetPrivateData, IDirectDrawSurface4::FreePrivateData