次の方法で共有

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 ルーチンは、IRQL が呼び出し元が指定した値に IRQL を変更 IoReleaseCancelSpinLockを呼び出すまで、IRQL = DISPATCH_LEVEL の任意のスレッド コンテキストで実行されます。 ドライバーは、この値 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_の詳細については、「関数の動作 に注釈を付けるを参照してください。

必要条件

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