Platform SDK: DirectX

IDirectMusicTrack::GetParam

The IDirectMusicTrack::GetParam method retrieves data from a track.

HRESULT GetParam(
  REFGUID rguidType, 
  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 Track Parameter Types.
mtTime
Time, in track time, from which to obtain the data.
pmtNext
Address of a variable to receive the track time (relative to the current time) until which the data is valid. If this returns a value of 0, either the data is always valid, or it is unknown when it might become invalid. If this information is not needed, pmtNext can be set to NULL.
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 following error values:

DMUS_E_NOT_FOUND
DMUS_E_NOT_INIT
DMUS_E_TYPE_DISABLED
DMUS_E_GET_UNSUPPORTED
E_POINTER

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.

See Also

IDirectMusicTrack::SetParam, IDirectMusicTrack::IsParamSupported, IDirectMusicPerformance::GetParam, IDirectMusicSegment::GetParam, Music Parameters