IDirectMusicStyle8::EnumBand

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicStyle8::EnumBand

The EnumBand method retrieves the name of the band with a specified index value.

Syntax

HRESULT EnumBand(
  DWORD dwIndex, 
  WCHAR * pwszName
);

Parameters

dwIndex

Zero-based index into the style's band list.

pwszName

Address of a buffer that receives 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 error values shown in the following table.

Return code
DMUS_E_TYPE_UNSUPPORTED
E_POINTER

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.