(Alarm Manager module)
Use GetAlarmStatus in new code.
| Description | Will indicate if an alarm is unacknowledged. It can be used either as a subroutine or as a function. |
| Returns | Numeric |
| Usage | Script Only. |
| Function Groups | Alarm |
| Related to: | GetAlarmStatus | IsActive | IsDisabled | IsShelved |
Format:  |
\AlarmManager\IsUnacked(AlarmName[, IncShelving]); |
| Parameters |
| AlarmName |
| Required. A text expression providing the name of an alarm. Not the alarm object value that was passed to the Register subroutine. |
| InclShelving |
| Optional Boolean. If TRUE, a shelved alarm will be reported here as non-acknowledged, regardless of its status. Defaults to TRUE. |
| Comments |
The IsUnacked subroutine returns a 1 if the alarm is unacknowledged and returns a 0 otherwise. In most cases, shelving an alarm is considered the same as masking the IsUnacked status to FALSE. (Makes it look like not unacknowledged, regardless of what it actually is.) For the rare use cases where shelving is to be ignored, the IncludeShelving parameter can be set to FALSE |
