8 ivscriptengine::setscriptvar, Ivscriptengine::setscriptvar – Teledyne LeCroy USB Analyzer Automation Manual User Manual

Page 91

Advertising
background image

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

91

5.1.8 IVScriptEngine::SetScriptVar

HRESULT SetScriptVar ( [in] BSTR var_name,
[in] VARIANT var_value )

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. 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
running verification script.


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 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.

Advertising