OnError Method of the IBatchEvents Interface

This method is implemented on the client side. It is called by ABBYY FlexiCapture SDK for some of the methods of the Project and Batch objects. It delivers to the client information about the errors which occur during page processing.

Syntax

Visual Basic .NET

Sub OnError( _
  ByVal Page As Page, _
  ByVal ErrorMessage As String, _
  ByRef ShouldTerminate As Boolean _
)
    

C++

HRESULT OnError(
  IPage*        Page,
  BSTR          ErrorMessage
  VARIANT_BOOL* ShouldTerminate
);
    

Parameters

Page
[in] This parameter refers to the Page object corresponding to the page which is currently processed.
ErrorMessage
[in] This parameter contains the text description of the error.
ShouldTerminate
[in, out] 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.

Remarks

A 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

IBatchEvents

Batch

Project

24.03.2023 8:48:38

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.