Start Method of the BatchProcessor Object

Start method of the BatchProcessor Object in the ABBYY FineReader Engine API — This method prepares the Batch Processor for work.

This method is implemented in FRE for Linux and Windows.

This method prepares the Batch Processor for work. The method invokes asynchronous recognition processes, specifies the source of images and processing settings.

The BatchProcessor object cannot be reused. Repeated calls to the Start method will cause errors.

Syntax

C++

HRESULT Start(
  IImageSource*             ImageSource,
  IAsyncProcessingCallback* ProcessingCallback,
  IPrepareImageMode*        OpeningParams,
  IPageProcessingParams*    ProcessingParams
);

C#

void Start(
  IImageSource             ImageSource,
  IAsyncProcessingCallback ProcessingCallback,
  IPrepareImageMode         OpeningParams,
  IPageProcessingParams     ProcessingParams
);

Visual Basic .NET

Sub Start( _
  ImageSource As IImageSource, _
  [ProcessingCallback As IAsyncProcessingCallback = Nothing], _
  [OpeningParams As IPrepareImageMode = Nothing], _
  [ProcessingParams As IPageProcessingParams = Nothing] _
)

Parameters

ImageSource

[in] Specifies the image source which should be used with the processor. The variable refers to the object which implements the IImageSource interface.

ProcessingCallback

[in] Refers to the IAsyncProcessingCallback interface of the user-implemented object which is used to manage processing. This parameter may be 0.

The callback will be used only with image files. If you add the images via the IImageSource::GetNextImageDocument method, you will not be able to manage the work of the BatchProcessor object with this interface.

OpeningParams

[in] Refers to the PrepareImageMode object which specifies how an image will be preprocessed during opening. This parameter may be 0. In this case, image preprocessing is performed with default parameters, or, if a profile has been loaded, the parameters set by this profile are used.

ProcessingParams

[in] Refers to the PageProcessingParams object that stores parameters of analysis, recognition, and page synthesis. This parameter may be 0. In this case, the page is analyzed and recognized with default parameters, or, if a profile has been loaded, the parameters set by this profile are used.

If you work with ImageDocument these parameters will be reset to default.

Return values

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

Remarks

For Linux: This method does not work if the Engine object is loaded as an out-of-process server.

See also

BatchProcessor