.PendingUpdates Dotfield
- Last UpdatedNov 07, 2016
- 1 minute read
Indicates the number of pending updates to the Distributed Alarm Display object. There are pending updates usually when the display is frozen and new alarm records are created. These do not show, but the pending updates count is increased.
Category
Alarms
Usage
[ErrorMessage=]GetPropertyI( "ObjectName.PendingUpdates", TagName);
Arguments
ObjectName
The name of the alarm object. For example, AlmObj_1.
TagName
An integer tag that holds the property value when the function is processed.
Remarks
This read-only dotfield contains the number of pending updates for a named Distributed Alarm Display object. Any value greater than zero indicates the Distributed Alarm Display object has new alarm data. This value is reset each time the object is refreshed.
Data Type
Integer (read-only)
Example
The following statement returns an integer 1 or greater if there are any pending updates for the AlmObj_1 Distributed Alarm Display object to the AlarmPendingUpdates tag:
GetPropertyI( "AlmObj_1.PendingUpdates",AlarmPendingUpdates);
See Also
GetPropertyI()