IO_CSQ_INSERT_IRP_EX回调函数 (wdm.h)

项目
02/27/2024

系统使用 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

指向插入操作的驱动程序定义上下文的指针。

返回值

如果 IRP 已成功插入，CsqInsertIrpEx 将返回STATUS_SUCCESS，或者在失败时返回相应的错误代码。

注解

驱动程序在初始化队列的IO_CSQ结构时为取消安全 IRP 队列指定 CsqInsertIrpEx 例程。驱动程序在初始化IO_CSQ时将例程指定为 IoCsqInitializeEx 的 CsqInsertIrp 参数。有关详细信息，请参阅取消安全 IRP 队列。

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_，请参阅批注函数行为。