Xantech CRM-WIC, Reference Manual

Page: 61 / 99

61
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] [???]]
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 Event Manager diagnostics.
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.
GetEventSchClockType ( EventId )
Returns the type of schedule used by a time based Event.
Syntax
HRESULT GetEventSchClockType(
[in] long EventId,
[out, retval] long* ClockType
);
Parameters
EventId [in] ID for the specified event.
ClockType [out, retval] Is set to 1, if the Event is a scheduled event, and 0, if the Event is a timer based event.
Remarks
This function is valid only for Clock and Timer Events.
Use this function to determine if the Event is based on a simple timer, or is using a more complicated schedule.