Microsoft DirectX 8.0 (C++)

IDirectMusicSong8::GetParam

Not implemented in DirectX 8.0.

Retrieves data from a track inside this song.

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. Set this value to 0xFFFFFFFF for all groups. See Remarks.
dwIndex
Index of the track in the group from which to obtain the data.
mtTime
Time from which to obtain the data, in performance time.
pmtNext
Address of a variable that receives the time, relative to mtTime, until which the data is valid. If this returns a value of zero, either the data is always valid, or it is not known when it might become invalid. If this information is not needed, pmtNext can be set to NULL.
pParam
Address of a buffer that receives the parameter data.

Return Values

If the method succeeds, the return value is S_OK or DMUS_S_GARBAGE_COLLECTED. See Garbage Collection.

If it fails, the method can return one of the following error values:

DMUS_E_GET_UNSUPPORTED
DMUS_E_NOT_FOUND
DMUS_E_TRACK_NOT_FOUND
E_POINTER

Requirements

  Header: Declared in dmusici.h.