This method copies the private data associated with the surface to a provided buffer.

HRESULT GetPrivateData(
  REFGUID refguid,
  void* pData,
  DWORD* pSizeOfData


  • refguid
    [in] Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to retrieve.
  • pData
    [in, out] Pointer to a previously allocated buffer to fill with the requested private data if the call succeeds. The application calling this method is responsible for allocating and releasing this buffer.
  • pSizeOfData
    [in, out] Pointer to the size of the buffer at pData, in bytes. If this value is less than the actual size of the private data (such as 0), the method sets this parameter to the required buffer size, and the method returns D3DERR_MOREDATA.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be one of the following values:


OS Versions: Windows CE .NET 4.0 and later.
Header: D3d8.h.
Link Library: D3d8.lib.

See Also

IDirect3DSurface8::FreePrivateData | IDirect3DSurface8::SetPrivateData | IDirect3DSurface8

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.