IDirectMusicObject::ParseDescriptor

Given a file stream, the IDirectMusicObject::ParseDescriptor method scans the file for data which 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 typically will not be used directly by an application. However, if an application implements an object type in DirectMusic, it should support this method.

HRESULT ParseDescriptor(
  LPSTREAM pStream, 
  LPDMUS_OBJECTDESC pDesc
);

Parameters

pStream
Stream source for file.
pDesc
Address of a DMUS_OBJECTDESC structure to receive data about the file.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method may return one of the following error values:

DMUS_E_CHUNKNOTFOUND
DMUS_E_INVALID_BAND
DMUS_E_INVALIDFILE
DMUS_E_NOTADLSCOL
E_POINTER

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.

See Also

IDirectMusicObject::SetDescriptor