Currentphasenumber, Itemsinphase – Echelon OpenLNS User Manual

Page 797

Advertising
background image

OpenLNS Programmer's Reference

760

CurrentPhaseNumber

Summary

An Integer indicating the current phase of the database

recovery process.

Availability

Local, full, and lightweight clients.

Syntax

phaseNumValue = rsObject.CurrentPhaseNumber

Element

Description

phaseNumValue

The current phase number as an

integer.
Valid values from this property are 0

to the value in the NumberPhases

property. This value can be used in

conjunction with the NumberPhases

property to provide a rough estimate

of progress in the database recovery

operation.

rsObject

The RecoveryStatus object to be acted

on.

Data Type

Integer.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

ItemsInPhase

Summary

A Long indicating the total items to be processed in this

phase.

Availability

Local, full, and lightweight clients.

Syntax

itemsValue = rsObject.ItemsInPhase

Element

Description

itemsValue

The number of items to be processed

.

The class of object that an 'item'

represents is determined by the

ProgressIndicatorType

property

.

rsObject

The RecoveryStatus object to be acted

on.

Data Type

Long.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

Advertising