IDirectMusicTrack8::GetParamEx

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicTrack8::GetParamEx

The GetParamEx method retrieves data from a track, in either music time or reference time.

Syntax

HRESULT GetParamEx(
  REFGUID rguidType, 
  REFERENCE_TIME rtTime, 
  REFERENCE_TIME* prtNext, 
  void * pParam
  void * pStateData,
  DWORD dwFlags
);

Parameters

rguidType

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

rtTime

Time from which to obtain the data. Unless DMUS_TRACK_PARAMF_CLOCK is set in dwFlags, this value is in music time.

prtNext

Address of a variable that receives the 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, prtNext 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.

pStateData

Address of a buffer containing state data for the track instance. This value is obtained from IDirectMusicTrack8::InitPlay.

dwFlags

Can be 0 or the following flag.

Value Description
DMUS_TRACK_PARAMF_CLOCK The value in rtTime is in clock time.

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
DMUS_E_TRACK_NO_CLOCKTIME_SUPPORT
E_POINTER

Requirements

  Header: Declared in dmplugin.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.