OnProgress Method of the IFRDocumentEvents Interface

OnProgress method of the IFRDocumentEvents Interface in the ABBYY FineReader Engine API — Client-side method called to report approximate percentage progress for FRDocument operations (image loading, analysis, recognition, etc.).

This method is implemented on the client-side. It is called by ABBYY FineReader Engine for some of the methods of the FRDocument object. It delivers to the client information about approximate percentage of the current operation (image loading, analysis, recognition, etc.). Its implementation may show a progress indicator, as it is done in ABBYY FineReader.

In Windows, it can also process any system messages to help prevent the application from appearing unresponsive during long operations. This can be helpful in applications with a user interface.

Syntax

C++

HRESULT OnProgress(
  IFRDocument*  Sender,
  int           Percentage,
  VARIANT_BOOL* Cancel
);

C#

void OnProgress(
  IFRDocument Sender,
  int        Percentage,
  ref bool   Cancel
);

Visual Basic .NET

Sub OnProgress( _
  Sender As IFRDocument, _
  Percentage As Integer, _
  ByRef Cancel As Boolean _
)

Parameters

Sender

[in] This parameter refers to the FRDocument object which sends notifications.

Percentage

[in] This parameter contains the percent of the work currently done. It is in the range from 0 to 100.

Cancel

[in, out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the 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 Cancel parameter is not taken into account.

Remarks

The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also

IFRDocumentEvents

FRDocument