'Declaration
 
Public Overloads Function ScanAsync( _
   ByVal pages As Integer, _
   ByVal scanDataType As ImGearIsisScanDataType, _
   ByVal fileFormat As ImGearIsisFileFormat, _
   ByVal pageRetrievedCallback As ImGearIsisPageRetrieved, _
   ByVal documentRetrievedCallback As ImGearIsisDocumentRetrieved _
) As ImGearIsisScanJob

'Usage
 
Dim instance As ImGearIsisScannerSession
Dim pages As Integer
Dim scanDataType As ImGearIsisScanDataType
Dim fileFormat As ImGearIsisFileFormat
Dim pageRetrievedCallback As ImGearIsisPageRetrieved
Dim documentRetrievedCallback As ImGearIsisDocumentRetrieved
Dim value As ImGearIsisScanJob
 
value = instance.ScanAsync(pages, scanDataType, fileFormat, pageRetrievedCallback, documentRetrievedCallback)

public ImGearIsisScanJob ScanAsync( 
   int pages,
   ImGearIsisScanDataType scanDataType,
   ImGearIsisFileFormat fileFormat,
   ImGearIsisPageRetrieved pageRetrievedCallback,
   ImGearIsisDocumentRetrieved documentRetrievedCallback
)

public: ImGearIsisScanJob* ScanAsync( 
   int pages,
   ImGearIsisScanDataType scanDataType,
   ImGearIsisFileFormat fileFormat,
   ImGearIsisPageRetrieved* pageRetrievedCallback,
   ImGearIsisDocumentRetrieved* documentRetrievedCallback
) 

public:
ImGearIsisScanJob^ ScanAsync( 
   int pages,
   ImGearIsisScanDataType scanDataType,
   ImGearIsisFileFormat fileFormat,
   ImGearIsisPageRetrieved^ pageRetrievedCallback,
   ImGearIsisDocumentRetrieved^ documentRetrievedCallback
) 

Parameters

pages

The number of pages to scan. A page is one side of a physical sheet of paper. Scanning continues until the specified number of pages have been scanned, or until you explicitly stop scanning. Specify a value of 0 or less to create a scan job that consists of all pages that are available to the scanner. For example, if the scanner has an automatic document feeder (ADF), then all of the pages in the feeder will be scanned. If the scanner is a flatbed scanner, only 1 page will be scanned. If the scanner is configured for multistream scanning (creating multiple image files for each page), then each stream produces an image per page. The resulting job contains p × s images, where p is the number of pages and s is the number of streams.

scanDataType

The type of data to return in the callback arguments. Multiple data types can be specified to return the data in multiple formats. An exception will occur if a base 64 scanned data retrieval option is specified in watermark evaluation mode as that mode does not support base 64 scanned data retrieval. An exception will occur if both a single page format (JPEG, JPEG 2000, or PNG) and a document retrieval scan data type (ImGearDocument or Base64Document) is specified. An exception will occur if the ZIP compression format is specified when retrieving an ImGearPage or ImGearDocument.

fileFormat

The file format and compression to use for the scanned images. Note that ImGearPage/ImGearDocument does not support PDF, and if a PDF file type and ImGearPage/ImGearDocument scan data type are specified, the ImGearPage/ImGearDocument will be loaded from TIFF rather than PDF. An exception will occur if both a single page format (JPEG, JPEG 2000, or PNG) and a document retrieval scan data type (ImGearDocument or Base64Document) is specified. An exception will occur if the ZIP compression format is specified when retrieving an ImGearPage or ImGearDocument.

pageRetrievedCallback

Callback which is called after each page is scanned, or after each page has been retrieved (if an ImGearPage and/or Base64Page is being retrieved).

documentRetrievedCallback

Callback which is called after all pages have been scanned or after the document has been retrieved (if an ImGearDocument and/or Base64Document is being retrieved).

Return Value

This method returns an ImGearIsisScanJob object which can be used to track the status. The file size of a scanned page or document is currently limited to 10 MB.

You must load a scanner before calling this method. Use the SetScannerAsync method to load a scanner.

Starting a scan job does not automatically end previous scan jobs. However, only one job at a time can be actively scanning. Scanning occurs in the same sequence as the jobs were opened. When you start a new scan job, all scanning activity from previously opened jobs is completed before any images are scanned by the new job.

You can end a scan job (deleting its data) but continue working in the same session by calling the ImGearIsisScanJob DestroyAsync method.

Reference