IDirectDrawSurface5::GetPrivateData

This 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:

DDERR_EXPIRED
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_MOREDATA
DDERR_NOTFOUND
DDERR_OUTOFMEMORY

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

See Also

IDirectDrawSurface5::SetPrivateData | IDirectDrawSurface5::FreePrivateData

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.