IDirectMusicTrack8::GetParam

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicTrack8::GetParam

The GetParam method retrieves data from a track, in music time.

Syntax

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 Standard Track Parameters.

mtTime

Time, in track time, from which to obtain the data.

pmtNext

Address of a variable that receives 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 error values shown in the following table.

Return code
DMUS_E_NOT_FOUND
DMUS_E_NOT_INIT
DMUS_E_TYPE_DISABLED
DMUS_E_GET_UNSUPPORTED
E_POINTER

Remarks

The IDirectMusicTrack8::GetParamEx method can be used for greater functionality.

Requirements

  Header: Declared in dmplugin.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.