​.NumAlarms Dotfield

Contains the number of alarms within a Distributed Alarm Display object.

Category

Alarms

Syntax

[ErrorNum=]GetPropertyI("ObjectName.NumAlarms", Tagname);

Parameters

ObjectName

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

TagName

An integer tag that holds the current number of alarms registered in a named Distributed Alarm Display object. This includes not only those alarms shown, but all alarms registered.

Remarks

This read-only dotfield returns the total number of alarms within a Distributed Alarm Display object.

Data Type

Integer (read-only)

Example

The following statement returns the current number of alarms used by the AlmObj_1 Distributed Alarm Display object to the AlarmCount integer tag:

GetPropertyI("AlmObj_1.NumAlarms",AlarmCount);

See Also

GetPropertyI()