​.Freeze Dotfield

The .Freeze dotfield reads the freeze status or freezes/unfreezes the Distributed Alarm Display object.

Category

Alarms

Usage

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

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

Arguments

ObjectName

The name of the alarm object. For example, AlmObj_1.

TagName

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

Remarks

A read-write dotfield that contains or changes the freeze status of a Distributed Alarm Display object. When the alarm display object is frozen, the shown alarms cannot be updated nor can new alarms be added. Freeze has no effect on whether the alarms flash or not.

Data Type

Discrete (read-write)

Valid Values

0 = Freeze OFF

1 = Freeze ON

Example

The following statement sets the Freeze property for the "AlmObj_1" from the AlmFreeze discrete tag.

SetPropertyD("AlmObj_1.Freeze",AlmFreeze);

See Also

GetPropertyD(), SetPropertyD()