ImageScanner.ScanFilesToFolderAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定したスキャン ソースを使用してスキャン ジョブを開始し、TIFF、XPS、PDF などの 1 つのマルチページ ファイルに 1 つまたは複数のイメージを書き込みます。または、DIB、PNG、JPG、TIFF などの 1 つまたは複数のシングルページ ファイルを指定したフォルダーの場所に移動します。 スキャンの進行状況を返します。
public:
virtual IAsyncOperationWithProgress<ImageScannerScanResult ^, unsigned int> ^ ScanFilesToFolderAsync(ImageScannerScanSource scanSource, StorageFolder ^ storageFolder) = ScanFilesToFolderAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<ImageScannerScanResult, uint32_t> ScanFilesToFolderAsync(ImageScannerScanSource const& scanSource, StorageFolder const& storageFolder);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<ImageScannerScanResult,uint> ScanFilesToFolderAsync(ImageScannerScanSource scanSource, StorageFolder storageFolder);
function scanFilesToFolderAsync(scanSource, storageFolder)
Public Function ScanFilesToFolderAsync (scanSource As ImageScannerScanSource, storageFolder As StorageFolder) As IAsyncOperationWithProgress(Of ImageScannerScanResult, UInteger)
パラメーター
- scanSource
- ImageScannerScanSource
イメージ スキャン ソース。
- storageFolder
- StorageFolder
スキャンされたファイルのターゲット フォルダーの場所。
戻り値
Windows.Foundation.IAsyncOperationWithProgress<Windows.Devices.Scanners.ImageScannerScanResult,unsigned int>
IAsyncOperationWithProgress<ImageScannerScanResult,uint32_t>
ImageScannerScanResult からスキャンされたイメージ ファイルの一覧と、ターゲット フォルダーに転送されたファイルの数を示す UInt32 からの WIA スキャン ジョブの進行状況。
- 属性
注釈
ファイルは一時名を使用して名前が付けられ、ファイル形式の種類に応じて標準のファイル拡張子が付けられます。
注意
UWP アプリでは、このメソッドが呼び出されると、アプリが表示され、フォアグラウンドで実行されている必要があります。
アプリが非同期呼び出しを取り消すと、現在のスキャン ジョブのキャンセル要求が開始されます。 アプリが非同期呼び出しを取り消した場合、スキャン ジョブが取り消される保証はありません。 取り消しが行われると、スキャナーは次の理由で停止する可能性があります。
- スキャナーのスキャンが停止するまでに数秒かかります。
- 用紙が切れた場合にのみ停止します (フィーダー取得の場合)。
- それはベッドの端にスキャンヘッドの実行を完了し、完全に(フラットベッドの獲得のために)その駐車場所にスキャンヘッドを戻す。
内部的には、非同期キャンセルは、アプリ内から取り消された現在の WIA 2.0 スキャン ジョブにフラグを設定します。 WIA デバイスが WIA サービスへの次のコールバックを行う場合、ジョブの取り消しが WIA ドライバーと正常に通信される場合と正しく通信されない場合があります。 ただし、WIA ドライバーがコールバックの 1 つからキャンセル要求を受け取った場合でも、ドライバーがスキャナーのスキャンを、予測可能な期間の直後または直後に正常に停止できる保証はありません。
WIA 固有の HRESULT エラー コードと、この関数が返す標準 COM HRESULT エラー コードの一覧を次に示します。
注意
(API は、WIA 固有のエラー HRESULT に対して WinRTOriginateError または OriginateErrorWithResourceString (すべての特定の WIA エラーにローカライズ可能なエラーの説明があります) を呼び出します)。
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 |
次の 2 つの特殊なケースがあります。
- S_FALSE の WIA の HRESULT は、取り消された非同期呼び出し (AsyncStatus.Canceled) に変換されます。
- WIA のWIA_ERROR_PAPER_EMPTYは、この API によって、空のファイルの一覧 (IVectorView.Size を 0 に設定) で正常に戻す (AsyncStatus.Completed) に変換されます。 孤立したファイルを防ぐために、このメソッドは、障害が発生する前に、障害発生時にイメージの転送に使用された残りの孤立ファイルをすべて削除します。 メソッドは、転送ファイルを一時ファイルとして保存し、スキャン ジョブが完了するまで保持します。 アプリは、ドキュメントを再スキャンするようにユーザーに指示する必要があります。