Echelon OpenLNS - Manual (Page 736)

OpenLNS Programmer's Reference 699
OnDbValidationEvent
Summary Provides a client application the progress of database
validation. A database validation can be initiated with the
Validate method .
Depending on the size of a network database, a database
validation can take a considerable amount of time to
complete. You can use the information returned by this event
to develop an idea of how long the database validation being
performed will take. This event will be fired many times
throughout the database validation, including each time the
validation progresses to a new phase, and each time the
validation progresses to a new step within that phase.
Alternatively, you can also receive updates for a database
validation directly through an ILcaProgressListener interface
object. In order to do so, you must specify the
progressCallback element when you call the Validate method.
The number of phases and the names of the steps and phases
involved in a database validation may differ from datatabase
to database, and from release to release. You can use them to
display a progress bar with your application, but you should
not expect this event to return for the same number of phases
or steps each time you perform a database validation.
Syntax OnDbValidationEvent (totalPercentage as Long,
thisPhasePercentage as Long, thisPhaseNumber as Long,
totalPhases as Long, thisPhaseName as String, thisStepName
as String)
Element Description
totalPercentage The percentage of the database
validation that has been
completed. This element has a
range of 0–100.
thisPhasePercentage The percentage of the current
phase of the database validation
that has been completed.
You can use the thisPhaseName
element to determine which phase
of the database validation is
currently being performed. This
element has a range of 0–100.
thisPhaseNumber The number of the current phase.
This element has a range of 0–
2,147,483,647.
totalPhases The total number of phases to be
performed during the database
validation. This element has a
range of 0–4,292,967,296.
thisPhaseName The name of the phase of the