| Microsoft DirectX 8.1 (C++) |
The GetVariableVariant method retrieves a variant value from a variable declared in the script.
Syntax
HRESULT GetVariableVariant(
WCHAR *pwszVariableName,
VARIANT *pvarValue,
DMUS_SCRIPT_ERRORINFO *pErrInfo
);Parameters
pwszVariableName
Name of the script variable.
pvarValue
Address of a variable that receives the value.
pErrInfo
Address of a DMUS_SCRIPT_ERRORINFO structure that receives information if an error occurs. Set this member to NULL if you do not want error information.
Return Values
If the method succeeds, one of the following success codes is returned:
| Return code | Description |
| S_OK | The value was retrieved. |
| S_FALSE | The variable does not exist in the script. |
| DMUS_S_GARBAGE_COLLECTED | See Garbage Collection. |
If the method fails, return values can include the following:
| Return code |
| DMUS_E_NOT_INIT |
| DMUS_E_SCRIPT_CONTENT_READONLY |
| DMUS_E_SCRIPT_UNSUPPORTED_VARTYPE |
| DMUS_E_SCRIPT_VARIABLE_NOT_FOUND |
| E_POINTER |
Requirements
Header: Declared in dmusici.h.
See Also