IDirectMusicTrack::IsParamSupported

The IDirectMusicTrack::IsParamSupported method determines whether the track supports a given data type in the IDirectMusicTrack::GetParam and IDirectMusicTrack::SetParam methods.

HRESULT IsParamSupported(
  REFGUID rguidType
);

Parameters

rguidType

Reference to (C++) or address of (C) the identifier of the type of data. See Track Parameter Types.

Return Values

If the method succeeds and the type is supported, the return value is S_OK.

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

Remarks

If a message type has been disabled by using one of the SetParam methods (see Disabling and Enabling Messages), the IDirectMusicTrack::IsParamSupported method returns DMUS_E_TYPE_DISABLED when passed the corresponding parameter type (either GUID_TempoParam or GUID_TimeSignature).

The method also returns DMUS_E_TYPE_DISABLED if passed GUID_DisableTempo when that message type has already been disabled, or if passed GUID_EnableTempo when that message type is currently enabled. The same is true for GUID_DisableTimeSig and GUID_EnableTimeSig.

The method returns DMUS_E_TYPE_UNSUPPORTED when the track does not support the message type referred to by a GUID_EnableTempo, GUID_EnableTimeSig, GUID_DisableTempo, or GUID_DisableTimeSig parameter type.

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::GetParam, IDirectMusicTrack::SetParam, Music Parameters