Deprecated. Do not use in new code.
(Alarm Manager module)
| Description: |
Use AlarmManager\EvaluateAlarm in all new code. Told the Alarm Manager to disable an alarm. Disable will also clear any active or unacknowledged state that might exist. |
| Returns: | 0 |
Usage:  |
Script Only. |
| Function Groups: | Alarm |
| Related to: | Register (Alarm Manager) | CurrentTime |
| Format: |
\AlarmManager\Disable(AlarmObject[, EventTime]); |
| Parameters: |
| AlarmObject |
| Required. The object value for the alarm that was passed to the Register subroutine that will be disabled. |
| EventTime |
| Optional. The time stamp to use when adding this event to the alarm lists. If invalid or not defined, the default is CurrentTime(). |
| Comments: | The Disable subroutine always returns "0". |
