Share via

IXACTCue::SetVariable

  • Article

IXACTCue::SetVariable

Stores a new value to a variable, referenced by its index.

[Content-driven]

  HRESULT 
  SetVariable(
  XACTVARIABLEINDEX nIndex,
  XACTVARIABLEVALUE nValue
);

Parameters

  • nIndex
    [in] Assigned index of the variable in which to store nValue.
  • nValue
    [in] Value to store in the variable.

Return Values

Returns S_OK if successful, an error code otherwise.

If the variable is private or read-only, SetVariable returns XACTENGINE_E_INVALIDVARIABLEINDEX.

If nValue falls outside of it's assigned range (or XACTVARIABLEVALUE_MIN to XACTVARIABLEVALUE_MAX), SetVariable returns E_FAIL. In this case, the variable is clamped within valid range and a warning message is sent to the debugger.

Requirements

Header: Declared in Xact.h.

Library: Use Xact.lib.

See Also

IXACTCue