Microsoft DirectX 9.0

IDirectMusicScript8::EnumRoutine

The EnumRoutine method retrieves the name of a routine in a script. This method might be used by authoring applications that need to enumerate all routines in a script.

Syntax

HRESULT EnumRoutine(
  DWORD dwIndex, 
  WCHAR *pwszName
);

Parameters

dwIndex

Zero-based index of the routine.

pwszName

Pointer to a string buffer that receives the name of the routine. Must contain at least MAX_PATH elements.

Return Values

If the method succeeds, one of the following success codes is returned:

Return code Description
S_OK The routine was enumerated.
S_FALSE There is no routine with the supplied index value.
DMUS_S_GARBAGE_COLLECTED See Garbage Collection.
DMUS_S_STRING_TRUNCATED The name is longer than MAX_PATH.

If the method fails, return values can include the following:

Return code
DMUS_E_NOT_INIT
E_POINTER

Requirements

  Header: Declared in dmusici.h.

See Also