Syntax
HRESULT SetEventById(
[in] long EventId,
[in] BSTR Name,
[in] long Type,
[in] long Concurrent,
[in] BSTR Source,
[in] BSTR Match,
[out, retval] VARIANT_BOOL* Success
);
Parameters
EventId
[in] ID for the specified Event.
Name
[in] Name of the specified 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 a list of valid values for
Source
).
Match
[in] Value to match to trigger the Event. If the Match value is an expression, then the
expression will need to evaluate to 1 to cause the Event to trigger.
Success
[out, retval] TRUE if specified Event was successfully set, FALSE if setting the Event failed.
Remarks
Call this function to set up an 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 to set or clear the expression flag for the Event’s match value.
SetEventByName ( Name, Type, Concurrent, Source, Match )
Using the name of an existing Event, this function sets the basic information about it.
Syntax
HRESULT SetEventByName(
[in] BSTR Name,
[in] long Type,
[in] long Concurrent,
[in] BSTR Source,
[in] BSTR Match,
[out, retval] VARIANT_BOOL* Success
);
Parameters
Name
[in] Name of the Event to set the information for.
Type
[in] Type of Event, e.g. Clock (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 as the source of the Event’s trigger (see GetEventSource
( EventId ), page
for valid values for
Source
).
14