Microsoft DirectX 9.0

IDirectMusicPerformance8::GetGlobalParam

The GetGlobalParam method retrieves a global parameter that has been set by IDirectMusicPerformance8::SetGlobalParam.

Syntax

HRESULT GetGlobalParam(
  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 allocated memory that receives a copy of the data. This must be the correct size, which is constant for each type of data. This parameter contains information that was passed in to the IDirectMusicPerformance8::SetGlobalParam method.

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 error values shown in the following table.

Return code
E_INVALIDARG
E_POINTER

Remarks

Do not assume that any parameter has a default value that can be retrieved by using GetGlobalParam. If SetGlobalParam has never been called for rguidType, the parameter might not be in the list of global data being handled by this performance, and GetGlobalParam might return E_INVALIDARG.

Requirements

  Header: Declared in dmusici.h.

See Also