Share via


XACTGetGlobalVariable

XACTGetGlobalVariable

Retrieves the value of a global variable by its index.

Windows:  This function is not supported on the Windows platform. Use IXACTEngine::GetGlobalVariable

  HRESULT 
  XACTGetGlobalVariable(
  XACTVARIABLEINDEX nIndex,
  XACTVARIABLEVALUE *pnValue
);

Parameters

  • nIndex
    [in] Assigned index of the global variable to retrieve.
  • pnValue
    [out] Pointer to where to store the value currently held by the global variable.

Return Values

Returns S_OK if successful, an error code otherwise.

Remarks

Note    This function has been deprecated. Titles should use IXACTEngine::GetGlobalVariable.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.