NumActions
[out, retval] Total number of Actions owned by specified Event.
GetActionDelay ( ActionId )
Returns the “Delay before start” value for the specified Action.
Syntax
HRESULT GetActionDelay(
[in] long ActionId,
[out, retval] double* Delay
);
Parameters
ActionId
[in] ID of the Action to examine.
Delay
[out, retval] Number of seconds to delay. A millisecond is represented as 0.001 seconds.
Remarks
For Actions that execute concurrently and for the first Action in the execution list, the value returned by this
function is the number of seconds that the Event Manager will wait after the owning Event has been triggered
before executing the Action.
For Actions that execute serially, the value is the amount of time to wait after the previous Action completed.
GetActionDutyCycle ( ActionId )
Returns the number of seconds to wait between successive executions of an Action.
Syntax
HRESULT GetActionDutyCycle(
[in] long ActionId,
[out, retval] double* Duty Cycle
);
Parameters
ActionId
[in] ID of the Action to examine.
DutyCycle
[out, retval] Number of seconds between successive executions.
Remarks
The
DutyCycle
returned is also known as the period of the Action. A serial Action with a
DutyCycle
of 1
second will send the output string out the serial port once every second.
GetActionHost ( ActionId )
Returns the name of the host that the Action is to be run on.
Syntax
HRESULT GetActionHost(
[in]long ActionId,
[out, retval]BSTR* Host
);
15