English (English)
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
C++
HRESULT Scan(
ScanSourceUITypeEnum UserInterfaceType,
BSTR Folder,
IScanCallback* callback,
IStringsCollection** Result
);
C#
IStringsCollection Scan(
ScanSourceUITypeEnum UserInterfaceType,
BSTR Folder,
IScanCallback* callback
);
Visual Basic .NET
Function Scan( _ UserInterfaceType As ScanSourceUITypeEnum, _ Folder As String, _ callback As IScanCallback _ ) As IStringsCollection
Parameters
- UserInterfaceType
- [in] This variable specifies the user interface type which is to be used for setting the scanning options as the ScanSourceUITypeEnum. Do not pass the SSUIT_All constant as this parameter. If you do not wish to display a dialog box, pass the SSUIT_None constant.
- 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 the null pointer.
- 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 FineReader Engine functions.
See also
17.09.2024 15:14:40