​.SuppressRetain Dotfield

Reads/writes the status of the feature that retains the suppression for the Distributed Alarm Display object.

Category

Alarms

Usage

[ErrorNumber=]GetPropertyD( "ObjectName.SuppressRetain",TagName);

[ErrorNumber=]SetPropertyD( "ObjectName.SuppressRetain",TagName);

Parameters

ObjectName

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

Tagname

A discrete tag that holds the property value when the script is processed.

Data Type

Discrete (read-write)

Valid Values

0 = Retain Off

1 = Retain On

Example(s)

The following statement sets the status of suppression retainer for the "AlmObj_1" from the SupRtn discrete tag:

SetPropertyD("AlmObj_1.SuppressRetain", SupRtn);

See Also

GetPropertyD(), SetProperty()