DirectX SDK

IDirectMusicPerformance::SetGlobalParam

The IDirectMusicPerformance::SetGlobalParam method sets global values for the performance.

HRESULT SetGlobalParam(
  REFGUID rguidType, 
  void* pParam, 
  DWORD dwSize
);

Parameters

rguidType
Reference to (C++) or address of (C) the identifier of the type of data.
pParam
Pointer to the data to be copied and stored by the performance.
dwSize
Size of the data. This is constant for each rguidType.

Return Values

If the method succeeds, the return value is S_OK.

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

E_FAIL
E_POINTER
E_OUTOFMEMORY

Remarks

The dwSize parameter is needed because the performance does not know about all types of data. New types can be created as needed.

For the parameters defined by DirectMusic and their associated data types, see Setting and Retrieving Global Parameters.

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

IDirectMusicPerformance::GetGlobalParam, IDirectMusicPerformance::SetParam, Music Parameters