Microsoft DirectX 9.0

IDirectMusicStyle8::EnumPattern

The EnumPattern method retrieves the name of a pattern with a specified index value and type. The name can be passed to the IDirectMusicPatternTrack8::SetPatternByName method.

Syntax

HRESULT EnumPattern(
  DWORD dwIndex, 
  DWORD dwPatternType,
  WCHAR* pwszName
);

Parameters

dwIndex

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

dwPatternType

One of the DMUS_STYLET_TYPES enumeration that specifies the type of pattern.

pwszName

Address of a buffer that receives the pattern name. The buffer should be of size MAX_PATH.

Return Values

If the method succeeds, the return value is S_OK, S_FALSE if there is no pattern with the given index value and type, or DMUS_S_STRING_TRUNCATED if the length of the motif 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
E_INVALIDARG
E_POINTER.

Requirements

  Header: Declared in dmusici.h.

See Also