IO_CSQ_COMPLETE_CANCELED_IRP回调函数 (wdm.h)

项目
03/08/2023

系统使用 CsqCompleteCanceledIrp 例程向驱动程序发出信号，表明它可以完成已取消的 IRP。

语法

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

void IoCsqCompleteCanceledIrp(
  [in] PIO_CSQ Csq,
  [in] PIRP Irp
)
{...}

参数

[in] Csq

指向取消安全 IRP 队列的IO_CSQ 结构的指针。

[in] Irp

指向要取消的 IRP 的指针。

返回值

无

备注

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

系统调用此例程以完成已从驱动程序队列中删除的已取消的 IRP。通常，驱动程序只需为状态为 STATUS_CANCELLED 的 IRP 调用 IoCompleteRequest 。

驱动程序在完成队列之前不需要从队列中删除 IRP，因为已取消：系统始终调用队列的 CsqRemoveIrp 例程，以在调用 CsqCompleteCanceledIrp 之前从队列中删除 IRP。

示例

若要定义 CsqCompleteCanceledIrp 回调例程，必须先提供一个函数声明来标识要定义的回调例程的类型。 Windows 为驱动程序提供了一组回调函数类型。使用回调函数类型声明函数可帮助驱动程序的代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，这是为 Windows 操作系统编写驱动程序的要求。

例如，若要定义名为 MyCsqCompleteCanceledIrp的 CsqCompleteCanceledIrp 回调例程，请使用 IO_CSQ_COMPLETE_CANCELED_IRP 类型，如以下代码示例所示：

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

然后，按如下所示实现回调例程：

_Use_decl_annotations_
VOID 
 MyCsqCompleteCanceledIrp(
    _In_ PIO_CSQ  Csq,
    _In_ PIRP  Irp
    )
  {
      // Function body
  }

IO_CSQ_COMPLETE_CANCELED_IRP函数类型在 Wdm.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 _Use_decl_annotations_ 注释添加到函数定义。注释 _Use_decl_annotations_ 可确保使用应用于头文件中IO_CSQ_COMPLETE_CANCELED_IRP函数类型的注释。有关函数声明要求的详细信息，请参阅使用 WDM 驱动程序的函数角色类型声明函数。有关的信息 _Use_decl_annotations_，请参阅批注函数行为。