Scan Method of the ScanSource Object

This method performs scanning of one or more images. It returns a collection of the names of the resulting image files.

One of the input parameters of this method receives a pointer to the IScanCallback scanning management interface.

This method does not return until scanning is completed. If you want to scan asynchronously, i.e. without blocking the execution of your program, use the BeginScan method of the same object.

Syntax

Visual Basic .NET

Function Scan( _
  OptionsInterfaceType As ScanOptionsInterfaceTypeEnum, _
  Folder As String, _
  callback As IScanCallback _
) As StringsCollection
    

C++

HRESULT Scan(
  ScanOptionsInterfaceTypeEnum OptionsInterfaceType,
  BSTR                         Folder,
  IScanCallback*               callback,
  IStringsCollection**         Result
);
    

Parameters

OptionsInterfaceType
[in] This variable specifies the interface type which is to be used for setting the scanning options as ScanOptionsInterfaceTypeEnum.
Folder
[in] This variable determines the path to the folder where the scans should be saved. Please note that this folder must already exist.
callback
[in] This variable is used to pass the pointer to the IScanCallback callback interface. This interface is used for scanning progress and completion notifications, or for errors that may occur during scanning. This parameter is optional. If you do not want to receive the notifications, pass NULL.
Result
[out, retval] A pointer to the IStringsCollection* pointer variable that receives the interface pointer of the StringsCollection object which will contain the file names of the scanned images.

Return values

This method may return the standard return values of ABBYY FlexiCapture SDK functions.

See also

ScanSource

15.08.2023 13:19:30

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.