Teledyne LeCroy Automation API for Bluetooth Exercisers - Manual (Page 15)

CATC Automation API for CATC Bluetooth Exercisers Manual Version 1.01
12
Value to be translated into a script argument. See section 2.14 VARIANTs and CSL
CValues.
Errors:
SCRIPTMANAGER_ERROR_SCRIPT_RUNNING:
The operation cannot be performed because a script is running.
SCRIPTMANAGER_ERROR_NO_SCRIPT:
No script object (either text or module) had been loaded.
Requirements:
BTTrainer 2.01
2.3.4 Stop Method
HRESULT Stop( LONG timeout )
Attempt to stop the script that is currently running. Scripts may take some time to stop if
they are executing blocking primitives. The timeout value specifies how long to wait
before returning failure. The operation may still complete after it has timed out.
LONG timeout [in]:
Length of time in ms. to wait for graceful script termination.
Errors:
Always succeeds.
Requirements:
BTTrainer 2.01
2.3.5 SetSymbol Method
HRESULT SetSymbol( BSTR identifier, VARIANT value )
Set the starting value of a global symbol in the currently loaded script or script module.
Returns an error if there is no script loaded. The symbol must be declared as a global in
the CSL script. Does not work on script constants.
BSTR identifier [in]:
The name of the global variable to change. Matches exactly name that was declared in
CSL script.
VARIANT value [in]:
The value of the symbol. See section 2.14 VARIANTs and CSL CValues.
Errors:
SCRIPTMANAGER_ERROR_SCRIPT_RUNNING: