8 ivscriptengine::setscriptvar, Ivscriptengine::setscriptvar – Teledyne LeCroy UWBTracer Automation Manual User Manual
Page 67

LeCroy
UWBTracer Automation API Reference Manual
Manual Version 3.02
63
5.1.8 IVScriptEngine::SetScriptVar
HRESULT SetScriptVar ( [in] BSTR var_name,
[in] VARIANT var_value )
This method allows you to set the value of some verification script variable before/after executing
the script. Only integers, strings, or arrays of VARIANTs are allowed as correct values. Arrays of
VARIANTs are converted into list values inside of scripts – see the CSL Manual for more details about list
objects.
Parameters
var_name
String providing the name of the global variable used in the verification script
being run.
var_value
VARIANT value containing new variable value.
Return values
E_PENDING
If this method is called when script running is in progress.
Remarks
This function may be useful because it allows you to set internal script variables before/after
script run, so you can make run-time customizations from COM/Automation client applications.
If there is no such global variable with the name 'var_name', a new variable with that name is
created.