​.AlarmLimit Dotfield

Returns the limit for the tag associated with a selected alarm. The alarm must be selected from the Distributed Alarm Display object in summary mode.

Category

Alarms

Usage

[ErrorNumber=]GetPropertyM ("ObjectName.AlarmLimit",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 pushbutton QuickScript, this statement returns the limit of the selected alarm to the almLimit tag.

GetPropertyM("AlmObj_1.AlarmLimit",almLimit);

Where AlmObj_1 is the name of the Distributed Alarm Display object and almLimit is a memory message containing the alarm limit for the tag associated with the selected alarm.

See Also

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