IDirect3DVolume9::GetPrivateData Method

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

Syntax

HRESULT GetPrivateData(      

    REFGUID refguid,
    void *pData,
    DWORD *pSizeOfData
);

Parameters

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

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 Value

If the method succeeds, the return value is D3D_OK.

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

D3DERR_INVALIDCALL	The method call is invalid. For example, a method's parameter may have an invalid value.
D3DERR_MOREDATA	There is more data available than the specified buffer size can hold.
D3DERR_NOTFOUND	The requested item was not found.

See Also

IDirect3DVolume9::FreePrivateData, IDirect3DVolume9::SetPrivateData