7 ivscriptengine::getscriptvar, Ivscriptengine::getscriptvar – Teledyne LeCroy USB Analyzer Automation Manual User Manual

Page 89

Advertising
background image

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite

89

5.1.7 IVScriptEngine::GetScriptVar

HRESULT GetScriptVar ( [in] BSTR var_name,
[out, retval] VARIANT* var_value )

Returns the value of some verification script variable before/after executing the script. The resulting
value may contain an integer, a string, or an array of VARIANTs (if the requested script variable is a list
object

– see the CSL Manual for more details about list objects).

Parameters

var_name

String providing the name of the global variable or constant
used in the running verification script.


var_value

Address of a VARIANT variable in which result will be stored.

Return values

E_PENDING

If this method is called when script running is in progress

Remarks

If there is no such global variable or constant with the name 'var_name', the resulting value contains an
empty VARIANT.

Advertising