GetAlarmName

(VTScada-Layer function. Must be called with a leading backslash.)

Description:	Returns the name of a given alarm within a tag for use with the AlarmManager's inquiry functions.
Returns:	Text
Usage:	Script or Steady State
Function Groups:	Alarms
Related to:	GetAlarmConfiguration | GetAlarmObject | GetAlarmStatus | IsActive | IsDisabled | IsShelved |IsUnacked
Format:	\GetAlarmName(TagObj[, Key])
Parameters:

TagObj

Required. A reference to a tag that contains an alarm.

Key

Optional text. Identifies which alarm to query within the tag. Typically, this will be any of "LowLow", "Low", "High", "HighHigh", or "Digital" Key is not case-sensitive. If set to a word other than those listed here, GetAlarmName will return Invalid.

Comments:

For tags that do not have a range of alarm types (PLC alarm, Alarm Point, Digital Status, Network Status, Pump Status, Selector Switch), do not provide a Key.

Example:

    \AlarmManager.IsActive(\GetAlarmName(\Root, "Low"));