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

  • [アーティクル]

Cancel ルーチンは、I/O 操作を取り消します。

構文

DRIVER_CANCEL DriverCancel;

void DriverCancel(
  [in, out] _DEVICE_OBJECT *DeviceObject,
  [in, out] _IRP *Irp
)
{...}

パラメーター

[in, out] DeviceObject

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

[in, out] Irp

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

戻り値

なし

解説

ドライバーまたはその他のシステム コンポーネントが IoCancelIrp を呼び出すと、I/O マネージャーは IRP の キャンセル ルーチンを呼び出します (IRP に登録されている場合)。

IRP の キャンセル ルーチンを登録するには、ドライバーは、次の 2 つの方法のいずれかを使用できます。

  1. StartIo ルーチンを提供し、I/O マネージャーが提供するデバイス キューを使用するドライバーは、IoStartPacket を呼び出すときに Cancel ルーチンを指定できます。

  2. 補助デバイス キューを作成および管理するドライバーは、IoSetCancelRoutine を呼び出すことによって Cancel ルーチンを登録できます。

一度に登録できる IRP の キャンセル ルーチンは 1 つだけです。

I/O マネージャーは、ドライバーの Cancel ルーチンを呼び出す前に IoAcquireCancelSpinLock を呼び出します。そのため、Cancel ルーチンは、ある時点で IoReleaseCancelSpinLock を呼び出す必要があります。 ルーチンは、スピン ロックを必要以上に長く保持しないでください。

Cancel ルーチンは、IOReleaseCancelSpinLock を呼び出すまで IRQL = DISPATCH_LEVELで任意のスレッド コンテキストで実行されます。これにより、IRQL が呼び出し元から指定された値に変更されます。 ドライバーでは、この値に Irp-CancelIrql> を指定する必要があります。

Cancel ルーチンは、I/O 状態ブロックの Status メンバーをSTATUS_CANCELLEDに設定し、その Information メンバーを 0 に設定する必要があります。 その後、 ルーチンは IoCompleteRequest を呼び出して、指定された IRP を完了する必要があります。

ドライバーの Cancel ルーチンの実装の詳細については、「 Irp の取り消し」を参照してください。

例

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

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

DRIVER_CANCEL MyCancel;

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

_Use_decl_annotations_
VOID
  MyCancel(
    struct _DEVICE_OBJECT  *DeviceObject,
    struct _IRP  *Irp
    )
  {
      // Function body
  }

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

要件

要件 値
対象プラットフォーム デスクトップ
Header wdm.h (Wdm.h、Ntddk.h、Ntifs.h を含む)
IRQL DISPATCH_LEVELで呼び出されます (「解説」セクションを参照)。