DRIVER_DISPATCH コールバック関数 (wdm.h)

コールバック ルーチンは、さまざまな IRP にサービスを提供します。 関数コードの一覧については、「解説」を参照してください。

構文

DRIVER_DISPATCH DriverDispatch;

NTSTATUS DriverDispatch(
  [in, out] _DEVICE_OBJECT *DeviceObject,
  [in, out] _IRP *Irp
)
{...}

パラメーター

[in, out] DeviceObject

呼び出し元が指定した DEVICE_OBJECT 構造体へのポインター。 これは、ドライバーの AddDevice ルーチンによって以前に作成されたターゲット デバイスのデバイス オブジェクトです。

[in, out] Irp

要求された I/O 操作を記述する IRP 構造体への呼び出し元から提供されるポインター。

戻り値

ルーチンが成功した場合は、STATUS_SUCCESSを返す必要があります。 それ以外の場合は、Ntstatus.h で定義されているエラー状態値のいずれかを返す必要があります。

注釈

すべてのディスパッチ ルーチンの入力パラメーターは、Irp が指す IRP 構造体で指定されます。 追加のパラメーターは、ドライバーの関連付けられた I/O スタックの場所に指定されます。 これは、IO_STACK_LOCATION 構造体によって記述され、 IoGetCurrentIrpStackLocation を呼び出すことによって取得できます。

通常、すべての ディスパッチ ルーチンは IRQL = PASSIVE_LEVELで任意のスレッド コンテキストで実行されますが、例外があります。 詳細については、「 ディスパッチ ルーチンと IRQL」を参照してください。

ディスパッチ ルーチンの詳細については、「ディスパッチ ルーチンの 作成」を参照してください。 IRP の詳細については、「 IRP の処理」を参照してください。

例

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

たとえば、 という名前MyDispatchCleanupの DispatchCleanup コールバック ルーチンを定義するには、次のコード例に示すように、DRIVER_DISPATCH型を使用します。

DRIVER_DISPATCH MyDispatchCleanup;

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

_Use_decl_annotations_
NTSTATUS
  MyDispatchCleanup(
    struct _DEVICE_OBJECT  *DeviceObject,
    struct _IRP  *Irp
    )
  {
      // Function body
  }

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

要件