Microsoft DirectX 8.1 (C++)

IDirectMusicSong8::EnumSegment

Not implemented in DirectX 8.1.

The EnumSegment method retrieves one of the segments that make up the song, by index.

Syntax

HRESULT EnumSegment(
  DWORD dwIndex,
  IDirectMusicSegment** ppSegment
);

Parameters

dwIndex

Index of the segment within the song.

ppSegment

Address of a variable that receives an IDirectMusicSegment interface pointer if a matching segment is found. Use QueryInterface to obtain IDirectMusicSegment8.

Return Values

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

Return code Description
S_OK The segment was enumerated.
S_FALSE There was no segment at dwIndex.
DMUS_S_GARBAGE_COLLECTED See Garbage Collection.

The method returns S_OK, or S_FALSE if dwIndex does not match any of the segments in the song.

If it fails, the method may return E_POINTER.

Requirements

  Header: Declared in dmusici.h.

See Also