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

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

CsqInsertIrpEx ルーチンは、ドライバー実装のキャンセルセーフな IRP キューに IRP を挿入するためにシステムによって使用されます。

構文

IO_CSQ_INSERT_IRP_EX IoCsqInsertIrpEx;

NTSTATUS IoCsqInsertIrpEx(
  [in] _IO_CSQ *Csq,
  [in] PIRP Irp,
  [in] PVOID InsertContext
)
{...}

パラメーター

[in] Csq

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

[in] Irp

IRP キューに挿入する IRP へのポインター。

[in] InsertContext

挿入操作のドライバー定義コンテキストへのポインター。

戻り値

CsqInsertIrpEx は、IRP が正常に挿入された場合はSTATUS_SUCCESSを返します。失敗した場合は適切なエラーコードが返されます。

注釈

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

IoCsqInsertIrpEx ルーチンは CsqInsertIrpEx を呼び出して、IRP をキューに挿入します。 IoCsqInsertIrpEx の InsertContext パラメーターは、CsqInsertIrpEx の InsertContext パラメーターとして渡されます。

例

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

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

IO_CSQ_INSERT_IRP_EX MyCsqInsertIrpEx;

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

_Use_decl_annotations_
NTSTATUS
 MyCsqInsertIrpEx(
    struct _IO_CSQ  *Csq,
    PIRP  Irp,
    PVOID  InsertContext
    )
  {
      // Function body
  }

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