(Alarm Manager module)
| Description: | Returns either the number of unacknowledged alarms or a Yes/No flag to indicate that the alarms exist. Note that this function will place a heavy load on computer resources while searching. Subject to the current user's Realm Filtering limitations. |
| Returns: | Numeric |
Usage:  |
Script or steady state. |
| Function Groups: | Alarm |
| Related to: | Register (Alarm Manager) | DBListGet | GetAlarmList |
| Format: |
\AlarmManager.GetNumUnacked(UserFilter, ReturnYesNoFlag); |
| Parameters: |
| UserFilter |
| Obsolete. Set to Invalid. |
| ReturnYesNoFlag |
| Required. A Boolean that controls the result returned by the function. If true, only a 1 or a 0 will be returned, indicating whether unacknowledged alarms were found. If false, the number of unacknowledged alarms will be returned. |
Example:
NumUnacked = \AlarmManager.GetNumUnacked(Invalid, FALSE);
If filtering is required, use GetAlarmList.
