IO_CSQ_INSERT_IRP callback function (wdm.h)

Artikel
02/22/2024

The CsqInsertIrp routine is used by the system to insert an IRP into a driver-implemented, cancel-safe IRP queue.

Syntax

IO_CSQ_INSERT_IRP IoCsqInsertIrp;

void IoCsqInsertIrp(
  [in] _IO_CSQ *Csq,
  [in] PIRP Irp
)
{...}

Parameters

[in] Csq

Pointer to the IO_CSQ structure for the cancel-safe IRP queue.

[in] Irp

Pointer to the IRP to insert into the IRP queue.

Return value

None

Remarks

The driver specifies the CsqInsertIrp routine for a cancel-safe IRP queue when it initializes the queue's IO_CSQ structure. The driver specifies the routine as the CsqInsertIrp parameter of IoCsqInitialize when it initializes IO_CSQ. For more information, see Cancel-Safe IRP Queues.

The IoCsqInsertIrp and IoCsqInsertIrpEx routines call CsqInsertIrp to insert the IRP into the queue.

Examples

To define a CsqInsertIrp callback routine, you must first provide a function declaration that identifies the type of callback routine you're defining. Windows provides a set of callback function types for drivers. Declaring a function using the callback function types helps Code Analysis for Drivers, Static Driver Verifier (SDV), and other verification tools find errors, and it's a requirement for writing drivers for the Windows operating system.

For example, to define a CsqInsertIrp callback routine that is named MyCsqInsertIrp, use the IO_CSQ_INSERT_IRP type as shown in this code example:

IO_CSQ_INSERT_IRP MyCsqInsertIrp;

Then, implement your callback routine as follows:

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

The IO_CSQ_INSERT_IRP function type is defined in the Wdm.h header file. To more accurately identify errors when you run the code analysis tools, be sure to add the _Use_decl_annotations_ annotation to your function definition. The _Use_decl_annotations_ annotation ensures that the annotations that are applied to the IO_CSQ_INSERT_IRP function type in the header file are used. For more information about the requirements for function declarations, see Declaring Functions by Using Function Role Types for WDM Drivers. For information about _Use_decl_annotations_, see Annotating Function Behavior.

Requirements

Requirement	Value
Target Platform	Desktop
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)

Delen via