Teledyne LeCroy USB Analyzer Automation Manual - Manual (Page 84)

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite
84
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 in which to store current VSE tag
newVal New tag for VSE
Return values
Remarks
Example
C++:
// In this example, use wrapper functions provided by #import directive.
IUsbTrace* usb_trace;
. . .
IUsbVerificationScript* usb_vscript = NULL;
usb_trace->QueryInterface( IID_ IUsbVerificationScript, (void**)&usb_vscript ) )
assert( usb_vscript != NULL );
IVScriptEngine* usb_vsengine = NULL;
usb_vsengine = usb_vscript -> GetVScriptEngine("Test_1");
assert( usb_vsengine != NULL );
usb_vsengine ->put_Tag( 0xDDAADDAA );
assert( usb_vsengine -> GetTag() == 0xDDAADDAA );
VS_RESULT result = usb_vsengine ->RunVScript();
if( result == PASSED )
{
::MessageBox( NULL, "Test 1 passed !!!", "UsbAnalyzer client", MB_OK );
}
. . .