IsShelved

(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. Unique name for the alarm. Typically the unique ID. If there are multiple built-in alarms in a tag, the convention is to concatenate the UniqueID with a separator and a unique integer per alarm. For example, Concat(Root\UniqueID, \AlarmSeparatorString, 0).

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;