OnError Method of the IAsyncProcessingCallback Interface

OnError method of the IAsyncProcessingCallback Interface in the ABBYY FineReader Engine API — This method is implemented on the client-side.

This method is implemented in FRE for Linux and Windows.

This method is implemented on the client-side. It is called by ABBYY FineReader Engine if an error occurs during processing with Batch Processor. Its implementation may report errors appeared during processing to the user. The method allows you to cancel operation.

Syntax

C++

HRESULT OnError(
  BSTR          FileName,
  int           PageIndex,
  BSTR          ErrorMessage,
  VARIANT_BOOL* Cancel
);

C#

void OnError(
  string   FileName,
  int      PageIndex,
  string   ErrorMessage,
  ref bool Cancel
);

Visual Basic .NET

Sub OnError( _
  FileName As String, _
  PageIndex As Integer, _
  ErrorMessage As String, _
  ByRef Cancel As Boolean _
)

Parameters

FileName

[in] Contains the name of the file, in which the error occurred.

PageIndex

[in] Contains the index of the page in the file, on which the error occurred.

ErrorMessage

[in] Contains the error message.

Cancel

[in, out] You may set this variable to TRUE to indicate that the process should be terminated. In this case, the processing function that reports the tip 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

IAsyncProcessingCallback

BatchProcessor