​.ProvidersRet Dotfield

Contains the number of alarm providers returned by the current query used by a named Distributed Alarm Display object.

Category

Alarms

Usage

[ErrorNumber=]GetPropertyI ("ObjectName.ProvidersRet",TagName);

Parameters

ObjectName

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

TagName

An integer tag that holds the number of alarm providers that have successfully returned their alarms to the named Distributed Alarm Display object.

Remarks

This read-only dotfield contains the number of alarm providers returned by the current query used by a named Distributed Alarm Display object.

Data Type

Integer (read-only)

Example

The following statement returns the number of alarm providers that have successfully returned their alarms to the AlmObj_1 Distributed Alarm Display object . This value is written to the RetProv integer tag:

GetPropertyI("AlmObj_1.ProvidersRet",RetProv);

See Also

GetPropertyI(), .ProvidersReq