IO_CSQ_COMPLETE_CANCELED_IRP回调函数 (wdm.h)
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 参数。 有关详细信息,请参阅 Cancel-Safe IRP 队列。
系统调用此例程以完成已从驱动程序队列中删除的已取消的 IRP。 通常,驱动程序只需为 IRP 调用 IoCompleteRequest,其状态为 STATUS_CANCELLED。
在取消队列之前,无需驱动程序从队列中删除 IRP:系统始终调用队列的 CsqRemoveIrp 例程,以在调用 CsqCompleteCanceledIrp之前从队列中删除 IRP。
例子
若要定义 CsqCompleteCanceledIrp 回调例程,必须先提供一个函数声明,用于标识要定义的回调例程的类型。 Windows 为驱动程序提供一组回调函数类型。 使用回调函数类型声明函数有助于 驱动程序代码分析、静态驱动程序验证程序(SDV)和其他验证工具查找错误,这是为 Windows作系统编写驱动程序的要求。
例如,若要定义 CsqCompleteCanceledIrp 名为 MyCsqCompleteCanceledIrp
的回调例程,请使用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_
的信息,请参阅 批注函数行为。
要求
要求 | 价值 |
---|---|
目标平台 | 桌面 |
标头 | wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h) |