OnProgress Method of the IProcessingEvents Interface

This method is implemented on the client side. It is called by ABBYY FlexiCapture SDK for some of the methods of the FieldsExtractionTrainer, ClassificationTrainer, and DataSetTableRecords objects. It delivers to the client information about approximate readiness of the current operation. Its implementation may show a progress indicator.

Important! For the IFieldsExtractionTrainer::Train method, a signal to cancel the operation does not guarantee its interruption.

Visual Basic .NET

Sub OnProgress( _
  ProcessedPercent As Integer, _
  ShouldTerminate  As Boolean _
)
    

C++

HRESULT OnProgress(
  int             ProcessedPercent,
  VARIANT_BOOL*   ShouldTerminate
);
    

Parameters

ProcessedPercent
[in] For an object implementing the IProcessingEvents interface connected to the FieldsExtractionTrainer, this parameter indicates whether the operation is complete or still in progress. If the value of the parameter is -1, the operation is in progress. If the value of the parameter is 100, the operation is complete.
For an object implementing the IProcessingEvents interface connected to the ClassificationTrainer, this parameter contains the percent of the work currently done. It is in the range from 0 to 100.
ShouldTerminate
[in] You may set this variable to TRUE to indicate that the process should be terminated. In this case the current processing function returns E_ABORT.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client side, and in this case the value of the ShouldTerminate parameter is not taken into account.

See also

IProcessingEvents

ClassificationTrainer

FieldsExtractionTrainer

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.