Syntax
HRESULT GetEventInfo(
[in]long EventId,
[out, retval] VARIANT* Info
);
Parameters
EventId
[in] ID of the Event of interest.
Info
[out, retval] An array of data values that define the Event.
Remarks
The
Info
array is filled with the following:
Element Field
Type
Info[0]
Name
BSTR
Info[1]
Type
long
Info[2]
Options unsigned long
Info[3]
Source
BSTR
Info[4]
Match
BSTR
Info[5]
Host
BSTR
Info[6]
Group
BSTR
Use
GetEventIds
or
GetEventByIdx
to get the ID of the Event.
GetEventMatch ( EventId )
Returns the expression to be evaluated or data to be compared when the Event is notified of a change in data
Syntax
HRESULT GetEventMatch(
[in] long EventId,
[out, retval] BSTR* Match
);
Parameters
EventId
[in] ID for the specified Event.
Match
[out, retval] The value that incoming data should be compared against to determine whether
the Event should be triggered.
Remarks
The
Match
value is either an expression or simple text value. How the
Match
value is evaluated depends on
the setting of “Expression” in the edit page for this Event.
If
Match
is an expression, then it is evaluated whenever there is a change in the Event’s source port, Variable,
etc. When the expression evaluates to non-zero, the Event is scheduled to run.
When
Match
is not an expression, then the incoming data is compared against the Match value. If the
Match
matches the data, then the Event is triggered to run.
13