Platform SDK: DirectX

IDirectMusicStyle::EnumBand

The IDirectMusicStyle::EnumBand method retrieves the name of the band with a given index value.

HRESULT EnumBand(
  DWORD dwIndex, 
  WCHAR * pwszName
);

Parameters

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

Return Values

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

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

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