ImageScanner ImageScanner ImageScanner ImageScanner Class

Gets and sets the scan settings of the auto-configured scan unit, like the file format, including compression to deliver the scanned data in. This property is ignored if the scanner is not capable of auto-configuration.

public : ImageScannerAutoConfiguration AutoConfiguration { get; }public ImageScannerAutoConfiguration AutoConfiguration { get; }Public ReadOnly Property AutoConfiguration As ImageScannerAutoConfiguration// You can use this property in JavaScript.

Gets the default scan source chosen for this scanner device.

public : ImageScannerScanSource DefaultScanSource { get; }public ImageScannerScanSource DefaultScanSource { get; }Public ReadOnly Property DefaultScanSource As ImageScannerScanSource// You can use this property in JavaScript.

Remarks

By default, the scan source will be selected from the device in this order of priority:

• 1. Auto
• 1. Flatbed
• 1. Feeder

Gets the PnP device identifier of this scanner device.

public : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// You can use this property in JavaScript.

Gets or sets the scan settings of the Feeder scan unit, like page size, orientation, and scan resolution.

public : ImageScannerFeederConfiguration FeederConfiguration { get; }public ImageScannerFeederConfiguration FeederConfiguration { get; }Public ReadOnly Property FeederConfiguration As ImageScannerFeederConfiguration// You can use this property in JavaScript.

Gets and sets the scan settings of the Flatbed scan unit, like scan resolution and color mode.

public : ImageScannerFlatbedConfiguration FlatbedConfiguration { get; }public ImageScannerFlatbedConfiguration FlatbedConfiguration { get; }Public ReadOnly Property FlatbedConfiguration As ImageScannerFlatbedConfiguration// You can use this property in JavaScript.

Creates an instance of a ImageScanner object based on a scanners device information ID. This method is required for broker device enumeration.

public : static IAsyncOperation<ImageScanner> FromIdAsync(PlatForm::String deviceId)public static IAsyncOperation<ImageScanner> FromIdAsync(String deviceId)Public Static Function FromIdAsync(deviceId As String) As IAsyncOperation( Of ImageScanner )// You can use this method in JavaScript.

Returns the class selection string that apps can use to enumerate scanner devices. This method is required for the brokered device enumeration.

public : static PlatForm::String GetDeviceSelector()public static string GetDeviceSelector()Public Static Function GetDeviceSelector() As string// You can use this method in JavaScript.

Determines if the specified scan source supports scan preview.

public : PlatForm::Boolean IsPreviewSupported(ImageScannerScanSource scanSource)public bool IsPreviewSupported(ImageScannerScanSource scanSource)Public Function IsPreviewSupported(scanSource As ImageScannerScanSource) As bool// You can use this method in JavaScript.

Determines if the specified scan source is available on the scanner.

public : PlatForm::Boolean IsScanSourceSupported(ImageScannerScanSource value)public bool IsScanSourceSupported(ImageScannerScanSource value)Public Function IsScanSourceSupported(value As ImageScannerScanSource) As bool// You can use this method in JavaScript.

Starts a scan job with the specified scan source and writes one or multiple images to one multi-page file like TIFF, XPS, and PDF; or one or multiple single-page files like DIB, PNG, JPG, and TIFF to the specified folder location. Returns the progress of the scan.

public : IAsyncOperationWithProgress<ImageScannerScanResult, unsigned int> ScanFilesToFolderAsync(ImageScannerScanSource scanSource, StorageFolder storageFolder)public IAsyncOperationWithProgress<ImageScannerScanResult, uint> ScanFilesToFolderAsync(ImageScannerScanSource scanSource, StorageFolder storageFolder)Public Function ScanFilesToFolderAsync(scanSource As ImageScannerScanSource, storageFolder As StorageFolder) As IAsyncOperationWithProgress( Of ImageScannerScanResult, uint )// You can use this method in JavaScript.

Remarks

The files are named using temporary names, with a standard file extension that depends on the file format type.

When the app cancels the async call, it initiates a cancellation request of the current scan job. There is no guarantee that if the app cancels the async call that the scan job will be canceled. If the cancellation goes through, the scanner may stop for these reasons:

• It takes a few seconds before the scanner stops scanning.
• It stops only when it runs out of paper (for a Feeder acquisition).
• It completes running the scan head to the end of the bed and then fully returns the scan head to its parked location (for a Flatbed acquisition).

Internally the async cancelation will flag the current WIA 2.0 scan job as canceled from within the app. If the WIA device makes the next callback to the WIA service the job cancellation may or may not be successfully communicated to the WIA driver. But, even if the WIA driver receives the cancel request from one of its callbacks there is no guarantee that the driver can successfully stop the scanner from scanning, immediately or after any predictable period of time.

Here's the list of WIA specific HRESULT error codes as well as standard COM HRESULT error codes this function returns.

WIA_ERROR_GENERAL_ERROR	WIA_ERROR_PAPER_JAM	WIA_ERROR_PAPER_EMPTY
WIA_ERROR_PAPER_PROBLEM	WIA_ERROR_OFFLINE	WIA_ERROR_BUSY
WIA_ERROR_WARMING_UP	WIA_ERROR_USER_INTERVENTION	WIA_ERROR_ITEM_DELETED
WIA_ERROR_DEVICE_COMMUNICATION	WIA_ERROR_INVALID_COMMAND	WIA_ERROR_INCORRECT_HARDWARE_SETTING
WIA_ERROR_DEVICE_LOCKED	WIA_ERROR_EXCEPTION_IN_DRIVER	WIA_ERROR_INVALID_DRIVER_RESPONSE
WIA_ERROR_COVER_OPEN	WIA_ERROR_LAMP_OFF	WIA_ERROR_MULTI_FEED

There are two special cases:

• The WIA’s HRESULT of S_FALSE will be translated to a canceled async call (AsyncStatus.Canceled).
• The WIA’s WIA_ERROR_PAPER_EMPTY will be translated by this API to a successful return (AsyncStatus.Completed) with an empty list of files (IVectorView.Size set to 0). To prevent orphan files, this method deletes any remaining orphan files used to transfer images upon failure, before the failure occurred. The method will save the transfer files as temporary files and keep them until the scan job completes. The app must instruct the user to rescan the document.

Scans one image from the specified scan source and applies the lowest scan resolution with the selected image file format.

public : IAsyncOperation<ImageScannerPreviewResult> ScanPreviewToStreamAsync(ImageScannerScanSource scanSource, IRandomAccessStream targetStream)public IAsyncOperation<ImageScannerPreviewResult> ScanPreviewToStreamAsync(ImageScannerScanSource scanSource, IRandomAccessStream targetStream)Public Function ScanPreviewToStreamAsync(scanSource As ImageScannerScanSource, targetStream As IRandomAccessStream) As IAsyncOperation( Of ImageScannerPreviewResult )// You can use this method in JavaScript.

Remarks

Attempting to preview from a Feeder that supports preview but is empty at the time will result in a successful completion of the async call. The app should check for the returned ImageScannerPreviewResult.Succeeded result before attempting to read data from the stream, especially when scanning from the Feeder.