.AlarmState Dotfield
- Last UpdatedNov 07, 2016
- 1 minute read
Returns the state of the selected alarm. The alarm has to be selected by clicking the Distributed Alarm Display object in summary mode.
Category
Alarms
Usage
[ErrorNumber=]GetPropertyM( "ObjectName.AlarmState",TagName);
Parameters
ObjectName
Name of the Distributed Alarm Display object. For example, AlmObj_1.
TagName
Any message tag.
Data Type
String (read-only)
Example
If used in a Touch Pushbutton QuickScript, this statement returns the state of the selected alarm to the almState tag.
GetPropertyM("AlmObj_1.AlarmState",almState);
Where AlmObj_1 is the name of the Distributed Alarm Display object and almState is a memory message tag containing the alarm state for the tag associated with the selected alarm.
See Also
GetPropertyM(), .AlarmAccess, .AlarmClass, .AlarmComment, .AlarmDate, .AlarmLimit, .AlarmName, .AlarmOprName, .AlarmOprNode, .AlarmPri, .AlarmProv, .AlarmTime, .AlarmType, .AlarmValue