Microsoft DirectX 8.1 (C++)

IDirectMusicSong8::GetSegment

Not implemented in DirectX 8.1.

The GetSegment method retrieves one of the segments that make up the song, by name.

Syntax

HRESULT GetSegment(
  WCHAR pwzName,
  IDirectMusicSegment** ppSegment
);

Parameters

pwzName

Name of the segment, or NULL to retrieve the first segment.

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  
S_OK The segment was retrieved.
S_FALSE pwzName does not match any segment.
DMUS_S_GARBAGE_COLLECTED See Garbage Collection.

If it fails, the method can return E_POINTER.

Requirements

  Header: Declared in dmusici.h.

See Also