Deprecated. Do not use in new code.
(Alarm Manager module)
| Description: | Will acknowledge an alarm. |
| Returns: | 0 |
Usage:  |
Script Only. |
| Function Groups: | Alarm |
| Related to: | Ack | CurrentTime | Register (Alarm Manager) |
| Format: |
\AlarmManager\Acknowledge(AlarmName[, EventTime, Operator]); |
| Parameters: |
| AlarmName |
| Required. The name of the alarm (not the alarm object value that was passed to the Register subroutine) that will be acknowledged |
| EventTime |
| Optional. Timestamp to use when adding this event to the alarm lists. Defaults to CurrentTime() |
| Operator |
| Optional text. The name of the operator who acknowledged the alarm. If invalid, the logged-in user (according to the Security Manager) will be used. If the Security Manger user is empty, then the application property, "LoggedOffLabel" will be used. |
| Comments: | This subroutine's primary responsibility is to send RPC messages to other workstations. DoAcknowledge does the actual work of acknowledging. When an acknowledgment is done, the only field that will change is status. To change any other field, a custom DoAcknowledge that is aware of the structure of alarms within the application must be written. |
