Teledyne LeCroy SAS_SATA Protocol Suite Verification Script Engine Reference Manual - Manual (Page 73)

73
Chapter 19: COM/Automation Communication
Functions
This group of functions covers VSE capabilities to communicate with COM/Automation clients
connected to the SASSuite/SATASuite application. (Refer to the SASSuite/SATASuite
Automation manual for the details on how to connect to the SASSuite/SATASuite application
and VSE.)
19.1 NotifyClient()
This function allows you to send information to COM/Automation client applications in a custom
format. The client application will receive a VARIANT object, which it is supposed to parse.
Format :
NotifyClient( event_id, param_list )
Parameters
event_id
Event identifier
param_list
List of parameters to be sent to the client application.
Each parameter might be an integer, string, or list.
(See CSL Manual for details about data types available in CSL.)
Because the list itself may contain integers, strings, or other lists, it is possible
to send complicated messages.
(Lists should be treated as arrays of VARIANTs.)
Example
…
if( SomeCondition() )
{
NotifyClient( 2, [ in.Index, in.Level,
TimeToText( in.Time )] );
}
…
# Here we sent 2 parameters to client applications :
# 2 ( integer ) and
# [ in.Index, in.Level, TimeToText( in.Time )] ( list )
Remark
See an example of handling this notification by client applications and parsing code in the
SASSuite/SATASuite Automation document.