| Microsoft DirectX 8.1 (C++) |
Given a file stream, the ParseDescriptor method scans the file for data that it can store in the DMUS_OBJECTDESC structure. All members that are supplied are marked with the appropriate flags in dwValidData.
This method is primarily used by the loader when scanning a directory for objects, and is not normally used directly by an application. However, if an application implements an object type in DirectMusic, it should support this method.
Syntax
HRESULT ParseDescriptor(
LPSTREAM pStream,
LPDMUS_OBJECTDESC pDesc
);
Parameters
pStream
Stream source for the file.
pDesc
Address of a DMUS_OBJECTDESC structure that receives data about the file.
Return Values
If the method succeeds, the return value is S_OK or DMUS_S_GARBAGE_COLLECTED. See Garbage Collection.
If it fails, the method can return one of the error values shown in the following table.
| Return code |
| DMUS_E_CHUNKNOTFOUND |
| DMUS_E_INVALID_BAND |
| DMUS_E_INVALIDFILE |
| DMUS_E_NOTADLSCOL |
| E_FAIL |
| E_OUTOFMEMORY |
| E_POINTER |
Requirements
Header: Declared in dmusici.h.
See Also