Teledyne LeCroy Verification Script Engine (VSE) Manual - Manual (Page 101)

Teledyne LeCroy Verification Script Engine Reference Manual
Page 101 of 115
21 COM/Automation Communication Functions
This group of functions covers VSE capabilities to co
mmunicate with COM/Automation™ clients connected to
the application. (See the Automation Manual for details about how to connect to the application and VSE.)
21.1 NotifyClient()
This function sends information to COM/Automation™ client applications in custom format. The client
application receives a VARIANT object, which it is supposed to parse.
Format:
NotifyClient(event_id, param_list)
Parameters:
event_id Integer parameter representing event identifier
param_list List of parameters to be sent to the client application.
Each parameter might be an integer, string, raw data (byte chain), or list.
Because the list itself may contain integers, strings, raw data, or other lists, it is possible
to send very complicated messages. (Lists should be treated as arrays of VARIANTs.)
Example:
...
if(SomeCondition())
{
NotifyClient(2, [ in.Index, "USB2 CHANNEL", "USB2 packet", in.Pid,
in. PayloadLength, TimeToText(in.Time)]);
}
...
# Send two parameters to client applications:
# 2 (integer),
# [ in.Index, "USB2 CHANNEL", "USB2 packet", in.Pid,
# in. PayloadLength, TimeToText(in.Time)] (list)
Remark:
See an example of handling this notification by client applications and parsing code in the Automation Manual.