OnWaitIntervalExceeded Method of the IParallelProcessingCallback Interface

OnWaitIntervalExceeded method of the IParallelProcessingCallback Interface in the ABBYY FineReader Engine API — Client-side method called when a wait interval timeout occurs during parallel processing; lets the client wait longer, reload processes, or cancel (Linux and Windows only).

This method is implemented in FRE for Linux and Windows.

This method is called by ABBYY FineReader Engine if wait interval timeout occurs during the parallel processing. Its implementation may report the errors to the user.

The method allows you to choose the reaction to the timeout: wait another time period, reload the processes and continue processing or cancel processing.

Syntax

C++

HRESULT OnWaitIntervalExceeded(
  BSTR                     Warning,
  TimeoutHandlingModeEnum* Mode
 );

C#

void OnWaitIntervalExceeded(
  string                      Warning,
  ref TimeoutHandlingModeEnum Mode
);

Visual Basic .NET

Sub OnWaitIntervalExceeded( _
  Warning As String, _
  ByRef Mode As TimeoutHandlingModeEnum _
)

Parameters

Warning

[in] Contains the error message and the list of files in progress. The numbers of document pages in progress are specified in format: “Page [Page number], image source file [File name]”.

Mode

[in, out] Contains the user reaction to the wait interval timeout. The list of possible reactions you can find in the TimeoutHandlingModeEnum description.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

IParallelProcessingCallback

Parallel Processing with ABBYY FineReader Engine