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

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

CsqPeekNextIrp ルーチンは、ドライバー実装のキャンセルセーフ IRP キューで次に一致する IRP を検索するためにシステムによって使用されます。

構文

IO_CSQ_PEEK_NEXT_IRP IoCsqPeekNextIrp;

PIRP IoCsqPeekNextIrp(
  [in]           PIO_CSQ Csq,
  [in, optional] PIRP Irp,
  [in, optional] PVOID PeekContext
)
{...}

パラメーター

[in] Csq

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

[in, optional] Irp

ドライバーの IRP キュー内の IRP へのポインター。キューの先頭を指定する 場合は NULL 。

[in, optional] PeekContext

ドライバー定義のコンテキスト情報へのポインター。 CsqPeekNextIrp ルーチンは、Irp に続く最初の IRP を返し、PeekContext と一致します。

戻り値

CsqPeekNextIrp は、キュー内の Irp に続く最初の IRP を 返し、 PeekContext と一致するか、一致する IRP がない場合は NULL を 返します。 Irp が NULL の場合、CsqPeekNextIrp は、キュー内の最初の一致する IRP を返します。一致する IRP がない場合は NULL を返します。

注釈

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

システムは CsqPeekNextIrp を使用して、ドライバーの IRP キュー内の IRP を反復処理します。たとえば、 IoCsqRemoveNextIrp ルーチンは、このルーチンを使用して、削除する IRP を検索します。

例

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

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

IO_CSQ_PEEK_NEXT_IRP MyCsqPeekNextIrp;

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

_Use_decl_annotations_
PIRP 
 MyCsqPeekNextIrp(
    PIO_CSQ  Csq,
    PIRP  Irp,
    PVOID  PeekContext
    )
  {
      // Function body
  }

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