beautypg.com

5 ivscriptengine::launchvscript, Ivscriptengine::launchvscript – Teledyne LeCroy UWBTracer Automation Manual User Manual

Page 63

background image

LeCroy

UWBTracer Automation API Reference Manual

Manual Version 3.02

59

5.1.5 IVScriptEngine::LaunchVScript

HRESULT LaunchVScript();

Launches verification script.

Parameters


Return values

S_FALSE

If VS Engine was not successfully launched (either it is already running or
verification script was not found).

Remarks

This method makes a “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
“OnVScriptFinished”

to the client event handler. You can also terminate script run using the method

“Stop”.

Example


C++: // In this example we use wrapper functions provided by #import directive
//
IUwbTrace*

uwb_trace;


. . .

IUwbVerificationScript* uwb_vscript = NULL;

uwb_trace->QueryInterface( IID_ IUwbVerificationScript, (void**)&uwb_vscript ) )

assert( uwb_vscript != NULL );

IVScriptEngine* uwb_vsengine = NULL;
uwb_vsengine = uwb_vscript -> GetVScriptEngine("Test_1");
assert( uwb_vsengine != NULL );

VS_RESULT result = uwb_vsengine ->

LaunchVScript

();


// You can go further without waiting the result from the VSE object.
// If you interested in the result you should implement the client event handler for
// OnVScriptFinished() notification.

. . .