Teledyne LeCroy UWBTracer Automation Manual - Manual (Page 60)

LeCroy UWBTracer Automation API Reference Manual Manual Version 3.02
56
5.1.2 IVScriptEngine::Tag
[propget] HRESULT Tag([out, retval] int* pVal);
[propput] HRESULT Tag([in] int newVal);
Property assigning and getting a tag to the VSE object. This tag is used in event notifications allowing a
client event handler to determine which VSE object sent the event.
Parameters
*pVal Address of variable where to keep current VSE tag.
newVal New tag for VSE.
Return values
Remarks
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 );
uwb_vsengine ->put_Tag( 0xDDAADDAA );
assert( uwb_vsengine -> GetTag() == 0xDDAADDAA );
VS_RESULT result = uwb_vsengine ->RunVScript();
if( result == PASSED )
{
::MessageBox( NULL, "Test 1 passed !!!", "UwbAnalyzer client", MB_OK );
}
. . .