ALTADataSet.UpdateCalculationProgress

From ReliaWiki
Revision as of 21:10, 26 February 2014 by Chris Kahn (talk | contribs)
Jump to navigation Jump to search


Called by an ALTADataSet object when the calculation progress should be updated.

Syntax

  • UpdateCalculationProgress( sender As ALTADataSet , msgx_0 As String, msgx_1 As String, pdone As Double, append_to As Boolean, Prev_increment As Long, Cancel As Boolean )

Parameters

sender: An ALTADataSet object.
msgx_0: The main display label.
msgx_1: The remaining label.
pdone : The percentage to display, in decimal form (0.00 to 0.99).
append_to: If True, append pdone to the current percentage value in the progress display at the rate of Prev_increment, otherwise pdone will replace the value.
Prev_increment: This is the value of the incremental value per progress update if append_to is True. If append_to is False, this value is ignored.
Cancel: This determines if the calculation can be cancelled.

Usage Example

Declare the ALTAEvents.
Declare the ALTADataSet.
Note: The ALTADataSet constructor already creates a new ALTAEvents, which could be used in place of AEvents in the example below.

       Dim AEvents as New ALTAEvents
       Dim ADS as New ALTADataSet

Update the calculation progress display.

       AEvents.UpdateCalculationProgress(ADS, "NewMessage1", "NewMessage2", 100, False, 0, True)