OnPageProcessed Method of the IFRDocumentEvents Interface

OnPageProcessed method of the IFRDocumentEvents Interface in the ABBYY FineReader Engine API — Client-side method called when an FRDocument finishes processing a page; can also pump Windows system messages to keep UI responsive.

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 page processing completed.

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 OnPageProcessed(
  IFRDocument*            Sender,
  int                     Index,
  PageProcessingStageEnum Stage
);

C#

void OnPageProcessed(
  IFRDocument              Sender,
  int                     Index,
  PageProcessingStageEnum Stage
);

Visual Basic .NET

Sub OnPageProcessed( _
  Sender As IFRDocument, _
  Index As Integer, _
  Stage As PageProcessingStageEnum _
)

Parameters

Sender

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

Index

[in] This parameter contains the index of the processed page.

Stage

[in] This variable of the PageProcessingStageEnum type specifies the stage of processing.

Return values

[C++ only] If this method returns a value other than S_OK, it indicates that an error occurred on the client-side.

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