Platform SDK: DirectX

IDirectMusicStyle::EnumMotif

The IDirectMusicStyle::EnumMotif method retrieves the name of a motif with a given index value.

HRESULT EnumMotif(
  DWORD dwIndex,
  WCHAR * pwszName
);

Parameters

dwIndex
Zero-based index into the style's motif list.
pwszName
Address of a buffer to receive the motif name. This should be of size MAX_PATH.

Return Values

If the method succeeds, the return value is S_OK, S_FALSE if there is no motif with the given index value, or DMUS_S_STRING_TRUNCATED if the length of the motif name is greater than MAX_PATH.

If it fails, the method can return E_POINTER.

Requirements

  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

IDirectMusicStyle::GetMotif, Using Motifs