IDirectMusicSegment8::GetParam

^{IDirectMusicSegment8::GetParam}

The GetParam method retrieves data from a track inside this segment.

Syntax

HRESULT GetParam(
  REFGUID rguidType,
  DWORD dwGroupBits,
  DWORD dwIndex,
  MUSIC_TIME mtTime, 
  MUSIC_TIME* pmtNext,
  void* pParam
);

Parameters

rguidType

Reference to (C++) or address of (C) the identifier of the type of data to obtain. See Standard Track Parameters.

dwGroupBits

Group that the desired track is in. Use 0xFFFFFFFF for all groups. For more information, see Identifying the Track.

dwIndex

Index of the track in the group identified by dwGroupBits from which to obtain the data, or DMUS_SEG_ANYTRACK to find the first track that contains the parameter.

mtTime

Time from which to obtain the data.

pmtNext

Address of a variable that receives the segment time (relative to mtTime) until which the data is valid. If this returns a value of 0, it means either that the data is always valid, or that it is unknown when it might become invalid. If this information is not needed, pmtNext can be set to NULL. See Remarks.

pParam

Address of an allocated structure in which the data is to be returned. The structure must be of the appropriate kind and size for the data type identified by rguidType.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return one of the error values shown in the following table.

Remarks

The data can become invalid before the time returned in *pmtNext if another control segment is cued. For more information, see Control Segments.

Requirements

  Header: Declared in dmusici.h.

See Also

• IDirectMusicSegment8 Interface
• IDirectMusicPerformance8::GetParam
• IDirectMusicSegment8::SetParam
• IDirectMusicTrack8::GetParamEx
• Performance Parameters