IDirect3DResource9::GetPrivateData method (d3d9helper.h)

Copies the private data associated with the resource to a provided buffer.

Syntax

HRESULT GetPrivateData(
  [in]      REFGUID refguid,
  [in, out] void    *pData,
  [in, out] DWORD   *pSizeOfData
);

Parameters

[in] refguid

Type: REFGUID

The globally unique identifier that identifies the private data to retrieve.

[in, out] pData

Type: void*

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. If this parameter is NULL, this method will return the buffer size in pSizeOfData.

[in, out] pSizeOfData

Type: DWORD*

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 value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DERR_MOREDATA, D3DERR_NOTFOUND.

Remarks

This method is inherited by the following interfaces:

IDirect3DResource9,

IDirect3DBaseTexture9,

IDirect3DCubeTexture9,

IDirect3DTexture9,

IDirect3DVolumeTexture9,

IDirect3DIndexBuffer9,

IDirect3DVertexBuffer9.

If the data returned is a pointer to an IUnknown, or one of its derivative classes, which was previously set by SetPrivateData with a D3DSPD_IUNKNOWN flag, that interface will have its reference count incremented before the private data is returned.

Requirements

See also

IDirect3DResource9