OnRegionProcessed Method of the IFRPageEvents Interface

This method is implemented on the client-side. It is called by ABBYY FineReader Engine for some of the methods of the FRPage object. It delivers to the client information about processing region. It may also process any Windows messages to avoid an effect that the application "is not responding" during long operations.



HRESULT OnRegionProcessed(
  IFRPage*      Sender,
  int           RecognitionPassNumber,
  IRegion*      Region,


void OnRegionProcessed(
  IFRPage   Sender,
  int      RecognitionPassNumber,
  IRegion   Region,
  ref bool Cancel

Visual Basic .NET

Sub OnRegionProcessed( _
  Sender As IFRPage, _
  RecognitionPassNumber As Integer, _
  Region As IRegion, _
  ByRef Cancel As Boolean _


[in] This parameter refers to the FRPage object which sends notifications.
[in] This parameter reports the number of the recognition pass. It may be 0, 1 or 2. Rectangles from different passes may be filled up with different colors as it is done in ABBYY FineReader.
[in] This parameter refers to the Region object which corresponds to the region which is processed.
[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.


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



24.03.2023 8:51:52

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.