.AlarmValue Dotfield
- Last UpdatedJul 18, 2024
- 1 minute read
Returns the value of the alarm for the tag associated with the selected alarm. The alarm must be selected from the Distributed Alarm Display object in summary mode.
Category
Alarms
Usage
[ErrorNumber=]GetPropertyM("ObjectName.AlarmValue,TagName);
Parameters
ObjectName
Name of the Distributed Alarm Display object. For example, AlmObj_1.
TagName
Any message tag.
Data Type
String (read-only)
Remarks
This function uses a message tag to retrieve the numeric value. This is because the GetProperty functions do not support real numbers. You can use the StringToReal() function to assign the result to a real tag.
Example
If used in a Touch Pushbutton QuickScript, this statement returns the value to almValue.
GetPropertyM("AlmObj_1.AlarmValue", almValue);
Where AlmObj_1 is the name of the Distributed Alarm Display object and almValue is a memory message tag containing the alarm value for the tag associated with the selected alarm.
See Also
GetPropertyM(), .AlarmAccess, .AlarmClass, .AlarmComment, .AlarmDate, .AlarmLimit, .AlarmOprName, .AlarmOprNode, .AlarmPri, .AlarmProv, .AlarmState, .AlarmTime, .AlarmType, .AlarmValue