IsDisabled

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

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;