EVT_SPB_CONTROLLER_WRITE コールバック関数 (spbcx.h)

SPB コントローラー ドライバーの EvtSpbControllerIoWrite イベント コールバック関数は、書き込み要求で指定されたバッファーから、指定されたターゲット デバイスにデータを書き込みます。

構文

EVT_SPB_CONTROLLER_WRITE EvtSpbControllerWrite;

void EvtSpbControllerWrite(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] size_t Length
)
{...}

パラメーター

[in] Controller

SPB コントローラーを表す フレームワーク デバイス オブジェクト への WDFDEVICE ハンドル。

[in] Target

この I/O 要求のターゲットに対する SPBTARGET ハンドル。 ターゲットは、バスに接続されている周辺機器またはポートです。 SPB フレームワーク拡張機能 (SpbCx) は、ターゲットへの接続を開いた EvtSpbTargetConnect コールバックで、このハンドルをターゲットに割り当てていました。

[in] Request

I/O 要求に対する SPBREQUEST ハンドル。 SPB コントローラー ドライバーは、要求された操作を実行するか、エラー状態を返すことによって、この要求を完了する必要があります。 詳細については、「解説」をご覧ください。

[in] Length

ターゲット デバイスに書き込むバイト数。

戻り値

なし

解説

SpbCx は、SPB コントローラーの I/O キューを管理します。 SPB コントローラーのクライアント (周辺機器ドライバー) がバスに接続されているターゲット デバイスにIRP_MJ_WRITE要求を送信すると、SpbCx は SPB コントローラー ドライバーの EvtSpbControllerIoWrite コールバック関数を呼び出します。 Request パラメーターの値は、この要求をカプセル化するハンドルです。

EvtSpbControllerIoWrite コールバックは状態値を返しません。 代わりに、SPB コントローラー ドライバーは、I/O 要求の完了状態での書き込み操作の状態を示します。

EvtSpbControllerIoWrite コールバックは非同期です。 つまり、コールバック関数は要求された書き込み操作を開始してから、操作の完了を待たずに を返す必要があります。 その後、SPB コントローラー ドライバーは、割り込み DPC またはタイマー DPC 中に書き込み要求を完了します。

EvtSpbControllerIoWrite コールバックは状態値を返しません。 代わりに、SPB コントローラー ドライバーは、I/O 要求の完了状態での書き込み操作の状態を示します。

書き込み操作が完全に完了した場合、コールバック関数は完了状態をSTATUS_SUCCESSに設定する必要があります。 転送が完了する前にターゲット デバイスがそれ以上データを受け入れられないことを示す場合、ドライバーは完了状態を STATUS_SUCCESS に設定し、送信されるバイト数を指定する必要があります。

書き込み操作中に送信エラーが発生した場合、ドライバーは I/O 要求の完了状態を適切なエラー コードに設定する必要があります。 すべてのバスに、トランスポート エラーまたは部分的に完了した転送を報告するメカニズムがターゲット デバイスに用意されているわけではありません。また、すべてのコントローラーがこれらの条件を検出できるわけではありません。

EvtSpbControllerIoWrite コールバック関数を登録するには、SpbDeviceInitialize メソッドを呼び出します。

例

EvtSpbControllerIoWrite コールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティング システム用のドライバーを記述するための要件になります。

たとえば、 という名前MyEvtSpbControllerIoWriteの EvtSpbControllerIoWrite コールバック関数を定義するには、次のコード例に示すように、EVT_SPB_CONTROLLER_WRITE関数型を使用します。

EVT_SPB_CONTROLLER_WRITE  MyEvtSpbControllerIoWrite;

次に、コールバック関数を次のように実装します。

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoWrite(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    size_t Length
    )
{ ... }

EVT_SPB_CONTROLLER_WRITE関数型は、Spbcx.h ヘッダー ファイルで定義されています。 コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のEVT_SPB_CONTROLLER_WRITE関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 8 以降でサポートされています。
対象プラットフォーム	デスクトップ
Header	spbcx.h
IRQL	IRQL <= DISPATCH_LEVELで呼び出されます。

こちらもご覧ください

• EvtSpbControllerIoRead
• EvtSpbTargetConnect
• IOCTL_SPB_EXECUTE_SEQUENCE
• IRP_MJ_WRITE
• SPBREQUEST
• SPBTARGET
• SpbDeviceInitialize