beautypg.com

7 ivscriptengine::getscriptvar, Parameters, Return values – Teledyne LeCroy Automation API for Teledyne LeCroy PETracer_PETrainer User Manual

Page 129: Remarks, Ivscriptengine::getscriptvar

background image

Teledyne LeCroy

Automation API for PETracer/PETrainer

124

9.1.7 IVScriptEngine::GetScriptVar

HRESULT GetScriptVar (

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


Returns the value of some verification script global variables before/after executing the script (refer to the
PETracer Verification Script Engine Manual and the File Based Decoding Manual for information on how a script
can declare and set global variables). The resulting value may contain an integer, a string, or an array of
VARIANTs (if a requested script variable is a list object – see the PETracer File Based Decoding Manual for
more details about list objects)

Parameters

var_name

String providing the name of the global variable or constant used in the

verification script running

var_value

Address of a VARIANT variable where the result is kept

Return values

E_PENDING

If this method is called when the script is already running

Remarks

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

empty VARIANT.