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

[アーティクル]
02/27/2024

CsqCompleteCanceledIrp ルーチンは、取り消された IRP を完了できることをドライバーに通知するシステムによって使用されます。

構文

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

void IoCsqCompleteCanceledIrp(
  [in] PIO_CSQ Csq,
  [in] PIRP Irp
)
{...}

パラメーター

[in] Csq

キャンセルセーフ IRP キューの IO_CSQ 構造体へのポインター。

[in] Irp

取り消す IRP へのポインター。

戻り値

なし

解説

ドライバーは、キューのIO_CSQ構造を初期化するときに、キャンセルセーフ IRP キューの CsqCompleteCanceledIrp ルーチンを指定します。ドライバーは、IO_CSQを初期化するときに、IoCsqInitialize または IoCsqInitializeEx の CsqCompleteCanceledIrp パラメーターとしてルーチンを指定します。詳細については、「 Cancel-Safe IRP Queues」を参照してください。

システムは、ドライバーのキューから削除された取り消された IRP を完了するには、このルーチンを呼び出します。通常、ドライバーは、状態が STATUS_CANCELLED の IRP に対して IoCompleteRequest を呼び出すだけです。

ドライバーは、取り消し済みとして完了する前にキューから IRP を削除する必要はありません。システムは常にキューの CsqRemoveIrp ルーチンを呼び出して、 CsqCompleteCanceledIrp を呼び出す前に IRP をキューから削除します。

例

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

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

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

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

_Use_decl_annotations_
VOID 
 MyCsqCompleteCanceledIrp(
    _In_ PIO_CSQ  Csq,
    _In_ PIRP  Irp
    )
  {
      // Function body
  }

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