Active
Deprecated. Do not use in new code.
(Alarm Manager module)
Description: |
Tells the Alarm Manager to activate an alarm. This subroutine will activate an alarm and signal it as unacknowledged. |
Returns: |
0 |
Usage:  |
Script Only. |
Function Groups: |
Alarm |
Related to: |
Register (Alarm Manager) (Alarm Manager) | CurrentTime | Normal | IsActive |
Format:  |
\AlarmManager\Active(AlarmObject[, EventTime]);
|
Parameters: |
|
AlarmObject |
Required. Object Value for the alarm that was passed to the active Register subroutine.
|
EventTime |
Optional, Timestamp to use when adding this event to the alarm lists. Defaults to CurrentTime()
|
Comments: |
The Active subroutine always returns "0". |
Trihedral and VTScada are registered trade marks of Trihedral Engineering Limited
© Trihedral Engineering Limited 1983- 2025 All rights reserved.