OnImageScanned Method of the IScanCallback Interface

OnImageScanned method of the IScanCallback Interface in the ABBYY FineReader Engine API — This method is implemented on the client-side.

This method is implemented in FRE for Windows.

This method is implemented on the client-side. It is called by ABBYY FineReader Engine each time an image is scanned. It delivers information about the course of scanning operation and allows scanning to be terminated if necessary.

Syntax

C++

HRESULT OnImageScanned(
  BSTR           SourceName,
  BSTR           path,
  VARIANT_BOOL*  Cancel
);

C#

void OnImageScanned(
  string     SourceName,
  string     path,
  ref bool   Cancel
);

Visual Basic .NET

Sub OnImageScanned( _
  SourceName As String, _
  path As String, _
  ByRef Cancel As Boolean _
)

Parameters

SourceName

[in] This parameter specifies the name of the scanning source from which the scanned image has been received.

path

[in] This parameter specifies the path to the resultant image file.

Cancel

[in, out] You may set this variable to TRUE to indicate that scanning should be terminated.

Return values

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

See also

IScanCallback