​.TotalPages Dotfield

Contains the total number of pages in the Distributed Alarm Display object.

Category

Alarms

Syntax

[ErrorNum=]GetPropertyI("ObjectName.TotalPages", TagName);

Parameters

ObjectName

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

TagName

An integer tag that retrieves the total number of alarm pages contained in the named Distributed Alarm Display object.

Remarks

This dotfield returns the total number of alarm pages contained in a named Distributed Alarm Display object. One page equals to all alarms shown in the object on the screen at any given time.

Data Type

Integer (read-only)

Example

The following statement returns the total number of pages contained in the AlmObj_1 Distributed Alarm Display object to the AlmTotalPages integer tag:

GetPropertyI( "AlmObj_1.TotalPages",AlmTotalPages);

See Also

GetPropertyI(), NextPage, PrevPage, PageNum