IWiaMiniDrvCallBack::MiniDrvCallback メソッド (wiamindr_lh.h)
MiniDrvCallback メソッドは、コールバック データ転送中に WIA ミニドライバーが使用するためのコールバック メソッドを提供します。
構文
HRESULT MiniDrvCallback(
[in] LONG lReason,
[in] LONG lStatus,
[in] LONG lPercentComplete,
[in] LONG lOffset,
[in] LONG lLength,
[in] PMINIDRV_TRANSFER_CONTEXT pTranCtx,
[in] LONG lReserved
);
パラメーター
[in] lReason
コールバックステータスメッセージを指定する定数値を指定します。 この値はコールバックの目的を決定するために使用され、次のいずれかの値を指定できます。
| Message | 定義 |
|---|---|
| IT_MSG_DATA | 転送バッファーにデータ ブロックが含まれていることを示します。 |
| IT_MSG_DATA_HEADER | データ転送の前に受信されます。 転送バッファーが、データ転送の要素を定義する WIA_DATA_CALLBACK_HEADER 構造体を指していることを示します。 |
| IT_MSG_DEVICE_STATUS | コールバックには、デバイスに関する状態情報のみが含まれます。 |
| IT_MSG_FILE_PREVIEW_DATA | プレビュー データがアプリケーションに転送されていることを示します。 |
| IT_MSG_FILE_PREVIEW_DATA_HEADER | プレビュー データが転送される前に、ヘッダーがアプリケーションに転送されていることを示します。 |
| IT_MSG_NEW_PAGE | ページのデータ転送が完了し、新しいページが送信されていることを示します。 |
| IT_MSG_STATUS | コールバックには、転送に関する状態情報のみが含まれます。 |
| IT_MSG_TERMINATION | データ転送が完了したことを示します。 |
[in] lStatus
転送の状態を指定します。 このパラメーターは、次の値のビットごとの OR です。
| Status | 定義 |
|---|---|
| IT_STATUS_TRANSFER_FROM_DEVICE | デバイスからデータを転送する。 |
| IT_STATUS_PROCESSING_DATA | デバイスやミニドライバーがデータを処理しています。 |
| IT_STATUS_TRANSFER_TO_CLIENT | ミニドライバーから WIA サービスへのデータの転送。 |
[in] lPercentComplete
転送されるデータの現在の割合を指定します。
[in] lOffset
バッファーの先頭から転送バッファーへの現在のオフセット (バイト単位) を指定します。
[in] lLength
転送に含まれるバイト数を指定します。
[in] pTranCtx
データ転送値を含む MINIDRV_TRANSFER_CONTEXT 構造体を指します。
[in] lReserved
予約済み。 0 に設定します。
戻り値
メソッドが成功すると、 S_OKが返されます。 クライアント アプリケーションによってコールバックが取り消された場合、メソッドは S_FALSEを返します。 メソッドが失敗した場合は、標準の COM エラー コードが返されます。
注釈
達成率の値は、ドライバーから直接送信されます。 WIA サービスは値を調整しません。
IT_MSG_FILE_PREVIEW_DATA_HEADER は帯域外データ用です。 これにより、ファイル転送を実行するアプリケーションは、縞模様のデータを表示できます。 これは、長さが不明でプレビュー スキャンがないスクロールフィード スキャナーに役立ちます。 このメッセージで報告される情報は、 IT_MSG_DATA_HEADERと同じように扱う必要があります。 ドライバーがこのメッセージをサポートしている場合は、ファイル転送中にプレビュー データを提供できます。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | wiamindr_lh.h (Wiamindr.h を含む) |