Microsoft DirectX 8.0 (C++)

IDirectMusicTrack8::IsParamSupported

Determines whether the track supports a given data type in the IDirectMusicTrack8::GetParam and IDirectMusicTrack8::SetParam methods.

HRESULT IsParamSupported(
  REFGUID rguidType
);

Parameters

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

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:

DMUS_E_TYPE_DISABLED
DMUS_E_TYPE_UNSUPPORTED
E_POINTER
E_NOTIMPL

Remarks

If a parameter has been disabled by using one of the SetParam methods, the IDirectMusicTrack8::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 parameter has already been disabled, or if passed GUID_EnableTempo when that parameter 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 parameter referred to by a GUID_EnableTempo, GUID_EnableTimeSig, GUID_DisableTempo, or GUID_DisableTimeSig parameter call.

Requirements

  Header: Declared in dmplugin.h.

See Also

IDirectMusicTrack8::GetParam, IDirectMusicTrack8::SetParam, Performance Parameters