(Alarm Manager module)
Use GetAlarmStatus in new code.
| Description: | Will indicate if an alarm is disabled. It can be used either as a subroutine or as a function. |
| Returns: | Numeric |
Usage:  |
Script Only. |
| Function Groups: | Alarm |
| Related to: | GetAlarmStatus | IsActive | IsShelved | IsUnacked |
| Format: |
\AlarmManager\IsDisabled (AlarmName); |
| Parameters: |
| AlarmName |
| Required. A text expression providing the name of an alarm. Not the alarm object value that was passed to the Register subroutine. |
| Comments: | The IsDisabled subroutine returns a 1 if the alarm is disabled and returns a 0 otherwise. |
Example:
Within a custom tag...
AlarmStatus = \AlarmManager\GetAlarmStatus(Root\UniqueID); AlarmDisabled = AlarmStatus\IsDisabled;
