Microsoft DirectX 8.1 (C++)

IDirectMusicObject8::GetDescriptor

The GetDescriptor method retrieves the object's internal description.

Syntax

HRESULT GetDescriptor(
  LPDMUS_OBJECTDESC pDesc
);

Parameters

pDesc

Address of a DMUS_OBJECTDESC structure to be filled with data about the object. Depending on the implementation of the object and how it was loaded from a file, some or all of the standard parameters are filled by GetDescriptor. Check the flags in the dwValidData member to ascertain which other members are valid.

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 E_POINTER.

Remarks

For an example, see Getting Object Descriptors.

Requirements

  Header: Declared in dmusici.h.

See Also