?/TD>
Microsoft DirectX 9.0

IDirectXFileData::GetData Method


Retrieves the data for one of the object's members or the data for all members.

Syntax

HRESULT GetData(      

    LPCSTR szMember,     DWORD *pcbSize,     void **ppvData );

Parameters

szMember
[in] Pointer to the name of the member for which to retrieve data. Specify NULL to retrieve all required members' data.
pcbSize
[out] Pointer to receive the ppvData buffer size, in bytes.
ppvData
[out] Address of a pointer to the buffer to receive the data associated with szMember. If szMember is NULL, ppvData is set to point to a buffer containing all required members' data in a contiguous block of memory.

Return Value

If the method succeeds, the return value is DXFILE_OK.

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

DXFILEERR_BADARRAYSIZEArray size is invalid.
DXFILEERR_BADDATAREFERENCEData reference is invalid.
DXFILEERR_BADVALUEParameter is invalid.


Remarks

This method retrieves the data for required members of a data object but no data for optional (child) members. Use IDirectXFileData::GetNextObject to retrieve child objects.

See Also

IDirectXFileData::GetNextObject


© 2002 Microsoft Corporation. All rights reserved.