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

[アーティクル]
08/07/2023

SPB コントローラードライバーの EvtSpbTargetDisconnect イベントコールバック関数は、ドライバーの EvtSpbTargetConnect イベントコールバック関数の呼び出しによって以前に開かれたターゲットデバイスへの接続を閉じます。

構文

EVT_SPB_TARGET_DISCONNECT EvtSpbTargetDisconnect;

void EvtSpbTargetDisconnect(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target
)
{...}

パラメーター

[in] Controller

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

[in] Target

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

戻り値

なし

解説

SPB コントローラードライバーによるこの関数の実装は省略可能です。

SpbCx は、SPB コントローラーの I/O キューを管理します。 SPB コントローラードライバーが EvtSpbTargetDisconnect コールバック関数を登録する場合、SpbCx は、コントローラードライバーのクライアント (周辺機器ドライバー) が SPBTARGET ハンドルを閉じる IRP_MJ_CLOSE 要求を送信するときに、この関数を呼び出します。このハンドルは、クライアントが以前の IRP_MJ_CREATE 要求で開いたバス上のターゲットデバイスへの接続を表します。 EvtSpbTargetDisconnect 関数がエラーコードを返した場合、SpbCx はIRP_MJ_CLOSE要求に失敗します。

EvtSpbTargetDisconnect 関数は、クライアントによって開始されたすべての I/O 操作が終了した後、およびクライアントがコントローラーのロックを解除した後 (クライアントが以前にコントローラーをロックしていた場合) に、クライアントの終了スレッドのコンテキストから同期的に呼び出されます。

SPB コントローラードライバーが I/O 要求を割り当て、ターゲットデバイスの I/O 要求チェーン内の次の下位ドライバーに送信した場合、 EvtSpbTargetDisconnect 関数は、これらの要求を返す前に取り消す必要があります。

クライアントドライバーの DispatchCleanup および CreateProcessNotifyEx コールバックルーチンは、 EvtSpbTargetDisconnect コールバックが返された後、いつでも呼び出すことができます。クライアントドライバーのプロセスが終了すると、プロセスを終了する最後のスレッドが破棄される直前に、その CreateProcessNotifyEx ルーチンが呼び出されます。

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

例

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

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

EVT_SPB_TARGET_DISCONNECT  MyEvtSpbTargetDisconnect;

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

_Use_decl_annotations_
VOID
  MyEvtSpbTargetDisconnect(
    WDFDEVICE Controller,
    SPBTARGET Target
    )
{ ... }

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

要件

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