IDirectMusicPerformance::GetGlobalParam

  • Article

This method retrieves global values from the performance.

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 to receive 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 IDirectMusicPerformance::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 following error values:

E_INVALIDARG
E_POINTER

Remarks

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 the method might return E_INVALIDARG. In other words, do not assume that any parameter has a default value that can be retrieved by using GetGlobalParam.

Requirements

OS Versions: Windows CE .NET 4.0 and Windows CE .NET 4.1.
Header: Dmusici.h.
Link Library: Dmusic.lib.

See Also

Music Parameters | IDirectMusicPerformance::GetParam | IDirectMusicPerformance::SetGlobalParam

 Last updated on Monday, April 12, 2004

© 1992-2002 Microsoft Corporation. All rights reserved.