Ivscriptengine::launchvscript – Teledyne LeCroy SAS_SATA Automation API manual User Manual
Page 126
![background image](/manuals/353598/126/background.png)
Teledyne LeCroy
SASVScriptEngine Object
120
Automation API for Teledyne LeCroy SAS/SATA Protocol Suite
IVScriptEngine::LaunchVScript
HRESULT LaunchVScript ( )
Launches the current verification script.
Parameters
Return Value
S_FALSE
If VS Engine was not successfully launched
(either it is already running, or the verification script was not found)
Remarks
This method makes an “asynchronous” call, which means that this method immediately
returns after the script starts running.
When the verification script stops running, the VSE object sends a special event
notification
IVScriptEngineEvents::OnVScriptFinished
to the client event handler. You can
also terminate the running script using the method
.
Example
C++:
// This example uses wrapper functions provided by the
#import directive.
ISASTrace* sas_trace;
. . .
ISASVerificationScript* sas_vscript = NULL;
sas_trace->QueryInterface( IID_ISASVerificationScript,
(void**)&sas_vscript ) )
assert( sas_vscript != NULL );
IVScriptEngine* sas_vsengine = NULL;
sas_vsengine = sas_vscript ->
GetVScriptEngine("Test_1");
assert( sas_vsengine != NULL );
VS_RESULT result = sas_vsengine ->LaunchVScript();
// You can go further without waiting for the result
from the VSE object.
// If you are interested in the result, implement the
client event handler
// for OnVScriptFinished() notification.
. . .