IoCsqInsertIrpEx 関数 (wdm.h)

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

IoCsqInsertIrpEx ルーチンは、ドライバーのキャンセルセーフ IRP キューに IRP を挿入します。

構文

NTSTATUS IoCsqInsertIrpEx(
  [in, out]       PIO_CSQ             Csq,
  [in, out]       PIRP                Irp,
  [out, optional] PIO_CSQ_IRP_CONTEXT Context,
  [in, optional]  PVOID               InsertContext
);

パラメーター

[in, out] Csq

ドライバーのキャンセルセーフ IRP キューの IO_CSQ 構造体へのポインター。この構造体は、 IoCsqInitialize または IoCsqInitializeEx によって初期化されている必要があります。

[in, out] Irp

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

[out, optional] Context

IO_CSQ_IRP_CONTEXT構造体へのポインター。 IoCsqInsertIrpEx は 、挿入された IRP のコンテキスト情報を使用してこの構造体を初期化します。ドライバーは、キューから IRP を削除する IoCsqRemoveIrp にこの値を渡します。ドライバーが IoCsqRemoveIrp を使用してキューからこの IRP を削除しない場合、コンテキストは NULL にすることができます。

[in, optional] InsertContext

ドライバー定義のコンテキスト値へのポインター。このパラメーターは、ドライバーの CsqInsertIrpEx ルーチンがある場合は渡されます。それ以外の場合、このパラメーターは無視されます。

戻り値

Csq パラメーターが IoCsqInitialize で初期化された場合、IoCsqInsertIrpEx は常にSTATUS_SUCCESSを返します。 Csq が IoCsqInitializeEx で初期化された場合、IoCsqInsertIrpEx はドライバーの CsqInsertIrpEx ルーチンによって返された値を返します。

注釈

IoCsqInsertIrpEx は、キューのディスパッチルーチンを使用して IRP を挿入します。 IoCsqInsertIrpEx ルーチン:

キューの CsqAcquireLock ルーチンを呼び出して、キューをロックします。
キューの IO_CSQ 構造体が IoCsqInitialize によって初期化された場合、 IoCsqInsertIrpEx は キューの CsqInsertIrp ルーチンを呼び出して IRP を挿入します。キューのIO_CSQ構造体が IoCsqInitializeEx によって初期化された場合、IoCsqInsertIrpEx はキューの CsqInsertIrpEx ルーチンを呼び出して IRP を挿入し、InsertContext パラメーターを CsqInsertIrpEx の InsertContext パラメーターとして渡します。
キューの CsqReleaseLock ルーチンを呼び出して、キューのロックを解除します。

挿入する IRP が既に取り消されている場合、 IoCsqInsertIrpEx は IRP をキューに挿入しません。

詳細については、「 Cancel-Safe IRP Queues」を参照してください。

IoCsqXxx ルーチンでは、IRP の DriverContext[3] メンバーを使用して IRP コンテキスト情報を保持します。これらのルーチンを使用して IRP をキューに入れるドライバーは、そのメンバーを使用しないようにする必要があります。

IoCsqInsertIrpEx の呼び出し元は、IRQL <= DISPATCH_LEVELで実行されている必要があります。ドライバーのコールバックルーチンは、この IRQL で正しく動作する必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows Server 2003 以降のバージョンの Windows オペレーティングシステムで使用できます。このルーチンは、Windows Driver Kit (WDK) と Windows Server 2003 用ドライバー開発キット (DDK) に付属する Csq.lib ライブラリでも使用できます。 Windows XP、Windows 2000、および Windows 98/Me でも動作する必要があるドライバーは、代わりに Csq.lib にリンクしてルーチンを使用できます。
対象プラットフォーム	ユニバーサル
Header	wdm.h (Wdm.h、Ntddk.h、Ntifs.h を含む)
Library	NtosKrnl.lib
[DLL]	NtosKrnl.exe
IRQL	<= DISPATCH_LEVEL (「解説」セクションを参照)
DDI コンプライアンス規則	IoAllocateFree(wdm), IoReuseIrp(wdm), IrpCancelField(wdm)、 RemoveLockCheck(wdm)、 RemoveLockForward(wdm)、 RemoveLockForward2(wdm)、 RemoveLockForwardDeviceControl(wdm)、 RemoveLockForwardDeviceControl2(wdm)、 RemoveLockForwardDeviceControlInternal(wdm)、 RemoveLockForwardDeviceControlInternal2(wdm)、 RemoveLockForwardRead(wdm)、 RemoveLockForwardRead2(wdm)、 RemoveLockForwardWrite(wdm)、 RemoveLockForwardWrite2(wdm)、 RemoveLockReleaseCleanup(wdm)、 RemoveLockReleaseClose(wdm)、 RemoveLockReleaseCreate(wdm)、 RemoveLockReleaseDeviceControl(wdm)、 RemoveLockReleaseInternalDeviceControl(wdm)、 RemoveLockReleasePower(wdm)、 RemoveLockReleaseRead(wdm)、 RemoveLockReleaseShutdown(wdm)、、 RemoveLockReleaseSystemControl(wdm), RemoveLockReleaseWrite(wdm)