​.AlarmComment Dotfield

Returns the alarm comment, which is a read/write text string that describes the alarm, not the tag. By default, the comment is empty in a new application.

However, when an old InTouch application is converted to InTouch version 7.11 or later, the tag comment is copied to the .AlarmComment dotfield for backward compatibility.

Category

Alarms

Usage

[ErrorNumber=]GetPropertyM( "ObjectName.AlarmComment",TagName);

Parameter

ObjectName

Name of the Distributed Alarm Display object. For example, AlmObj_1.

TagName

Any message tag.

Data Type

String (read-only)

Example

The following example returns the alarm comment for a tag selected in the AlmObj_1 Distributed Alarm Display object and places it in the almComment tag :

GetPropertyM("AlmObj_1.AlarmComment", almComment);

See Also

GetPropertyM(), .AlarmAccess, .AlarmClass, .AlarmDate, .AlarmLimit, .AlarmName, .AlarmOprName, .AlarmOprNode, .AlarmPri, .AlarmProv, .AlarmState, .AlarmTime, .AlarmType, .AlarmValue