2 ivscriptengine::tag – Teledyne LeCroy SAS_SATA Tracer_Trainer Automation API Manual User Manual

Page 73

Advertising
background image

LeCroy Corporation

Automation API for SAS/SATATracer/Trainer

Manual Version 1.11

73

8.1.2 IVScriptEngine::Tag


[propget] HRESULT Tag ( [out, retval] int* pVal )

[propget] HRESULT Tag ( [in] int newVal )

Property assigns and gets a tag to the VSE object. This tag will be used in event
notifications, allowing a client event handler to determine which VSE object sent the event.

Parameters

pVal

Address of the variable where the current VSE tag is kept


newVal

New tag for VSE

Return values


Remarks


Example


C++:
// In this example, we use 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 );

sas_vsengine ->PutTag( 0xDDAADDAA );
assert( sas_vsengine -> GetTag() == 0xDDAADDAA );

VS_RESULT result = sas_vsengine ->RunVScript();
if( result == PASSED )
{

::MessageBox( NULL, "Test 1 passed !!!", "SASTracer client", MB_OK );

}

. . .

Advertising