beautypg.com

3 _ivscriptengineevents::onnotifyclient, Ivscriptengineevents::onnotifyclient – Teledyne LeCroy USB Analyzer Automation Manual User Manual

Page 98

background image

Teledyne LeCroy Automation API Reference Manual for USBTracer, USB Advisor, and Voyager USB Protocol
Suite

98

6.1.3 _IVScriptEngineEvents::OnNotifyClient

[id(3)] HRESULT OnNotifyClient( [in] int eventId,

[in] VARIANT eventBody,
[in] int TAG );


Fires when running verification script calls NotifyClient() function.

Parameters

EventId

Event Id


eventBody

Body of event packed in a VARIANT object


TAG

VSE object's tag

Return values


Remarks

The information packed in the event body is opaque for VSE, which only packs the information given to
NotifyClient() function inside of a verification script into a VARIANT object and sends it to client
applications.
(See Teledyne LeCroy PSG USB Verification Script Engine Manual for details about the NotifyClient()
script function.)

Example


Teledyne LeCroy PSG USB Verification script:

ProcessEvent()
{

. . .
NotifyClient( 2, [in.Index, in.Level, GetChannelName(), GetEventName(),
TimeToText( in.Time )] );
. . .
}