 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
The IDirectDrawSurface5::GetPrivateDatamethod 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:
DDERR_EXPIRED DDERR_INVALIDOBJECT DDERR_INVALIDPARAMS DDERR_MOREDATA DDERR_NOTFOUND DDERR_OUTOFMEMORY Requirements
Runs on Versions Declared in Link to Windows CE OS 2.12 or later. Version 2.12 requires DXPAK 1.0 or later. ddraw.h ddraw.lib See Also
IDirectDrawSurface5::SetPrivateData, IDirectDrawSurface5::FreePrivateData