| Microsoft DirectX 9.0 SDK Update (Summer 2004) |
IDirectMusicScript8::SetVariableObject
The SetVariableObject method assigns an object interface pointer to a variable declared in the script.
Syntax
HRESULT SetVariableObject(
WCHAR* pwszVariableName,
IUnknown* punkValue,
DMUS_SCRIPT_ERRORINFO* pErrInfo
);Parameters
pwszVariableName
Name of the script variable.
punkValue
Interface pointer to assign to the variable. This can be an interface of one of the DirectMusic objects supported by the script engine, such as IDirectMusicSegment8, or an interface of any other object that implements the IDispatch interface.
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 set. |
| 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_VARIABLE_NOT_FOUND |
| E_POINTER |
Requirements
Header: Declared in dmusici.h.
See Also
© 2004 Microsoft Corporation. All rights reserved.