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