Event Methods
Most of the Event methods use the Event’s ID to retrieve information about an Event. The Event’s ID is
set when an Event is created, and is unique to the Event. The ID is re-issued when the system is powered
up or the reset button is pressed.
The index number of the Event within the Event list could change, depending on whether new Events are
added or existing Events are deleted.
AddEvent ( Name, Type, Concurrent, Source, Match )
Create a new Event with the specified parameters.
Syntax
HRESULT AddEvent(
[in] BSTR Name,
[in] long Type,
[in] long Concurrent,
[in] BSTR Source,
[in] BSTR Match,
[out, retval] long* EventId
);
Parameters
Name
[in] Name of the new Event.
Type
[in] Type of the Event, e.g. Serial (see GetEventType ( EventId ), page
for a list of types).
Concurrent
[in] Set to 1 to execute Actions concurrently, and 0 otherwise.
Source
[in] Port, Variable, etc. to be used for the source of the Event’s trigger (see GetEventSource
( EventId ), page
for details on valid
Source
values).
Match
[in] Value to match to trigger the Event.
EventId
[out, retval] ID of the new Event.
Remarks
Call this function to add a new Event. After making this call, a call to SetEventSchedule is required for all
Events of type Clock or Timer.
A call to SetEventOption should also to be made using the newly returned EventId to set or clear the expression
flag for the Event’s match value.
AddRemoteEvent ( Client, EventRecord )
Create a new temporary Event on a remote WACI.
Syntax
HRESULT AddRemoteEvent(
[in]BSTR Client,
[in]BSTR EventRecord,
[out, retval]long* EventId
);
12