Syntax
HRESULT GetEventByName(
[in] BSTR Name,
[out, retval] long* EventId
);
Parameters
Name
[in] Name of the Event to identify.
EventId
[out, retval] Event ID of the specified Event.
Remarks
The ID returned by
GetEventByName
is used by the Event functions to retrieve information about the named
Event, e.g. Name, Type, Actions, etc.
If
-1
is returned, then the Event specified by
Name
doesn’t exist. If
-2
is returned, then the Event represented
by
Name
is in the process of being deleted.
GetEventConcurrent ( EventId )
GetEventConcurrent returns a value signifying whether an Event’s Actions should run concurrently or
sequentially.
Syntax
HRESULT GetEventConcurrent(
[in] long EventId,
[out, retval] long* Concurrent
);
Parameters
EventId
[in] ID for the specified Event.
Concurrent
[out, retval] 1 if Actions should be executed concurrently, 0 if Actions should be executed
sequentially.
Remarks
When Actions are set to execute sequentially, the next Action in the list will not execute until the previous
Action has completely executed. So, if the first Action is set as one that executes an infinite number of times,
the second Action will never execute. Use the Up/Dn hyperlinks in the Event Manager Diagnostics screen’s
Action list to change the order of the Actions’ execution.
When Actions execute concurrently, the Event Manager determines the next Action to run by calculating its
next run time. The Event Manager uses the Action’s Delay and Repeat Every values to make this calculation.
The Action with the earliest next run time is run first. If two Actions have the same run time, the first Action in
the Action list will be executed first.
This flag can also be obtained user
GetEventOption
.
GetEventCount ( )
Returns the total number of Events.
13