DRIVER_CANCEL回调函数 (wdm.h)

Cancel 例程取消 I/O 操作。

语法

DRIVER_CANCEL DriverCancel;

void DriverCancel(
  [in, out] _DEVICE_OBJECT *DeviceObject,
  [in, out] _IRP *Irp
)
{...}

参数

[in, out] DeviceObject

调用方提供的指向 DEVICE_OBJECT 结构的指针。 这是目标设备的设备对象，以前由驱动程序的 AddDevice 例程创建。

[in, out] Irp

调用方提供的指向 IRP 结构的指针，该结构描述要取消的 I/O 操作。

返回值

无

备注

当驱动程序或其他系统组件调用 IoCancelIrp 时，I/O 管理器会调用 IRP 的 Cancel 例程（如果已为 IRP 注册）。

若要为 IRP 注册 Cancel 例程，驱动程序可以使用以下两种方法之一：

1. 提供 StartIo 例程并使用 I/O 管理器提供的设备队列的驱动程序可以在调用 IoStartPacket 时指定 Cancel 例程。

2. 创建和管理补充设备队列的驱动程序可以通过调用 IoSetCancelRoutine 来注册 Cancel 例程。

一次只能为 IRP 注册一个 Cancel 例程。

I/O 管理器在调用驱动程序的 Cancel 例程之前调用 IoAcquireCancelSpinLock，因此 Cancel 例程必须在某个时候调用 IoReleaseCancelSpinLock。 例程不应保留旋转锁的时间超过必要时间。

Cancel 例程在 IRQL = DISPATCH_LEVEL的任意线程上下文中执行，直到调用 IoReleaseCancelSpinLock，这将 IRQL 更改为调用方提供的值。 驱动程序应为此值指定 Irp-CancelIrql>。

Cancel 例程必须将 I/O 状态块的 Status 成员设置为 STATUS_CANCELLED，并将其 Information 成员设置为零。 然后，该例程必须通过调用 IoCompleteRequest 完成指定的 IRP。

有关实现驱动程序的 Cancel 例程的详细信息，请参阅 取消 IRP。

示例

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

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

DRIVER_CANCEL MyCancel;

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

_Use_decl_annotations_
VOID
  MyCancel(
    struct _DEVICE_OBJECT  *DeviceObject,
    struct _IRP  *Irp
    )
  {
      // Function body
  }

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

要求

要求	值
目标平台	桌面
标头	wdm.h（包括 Wdm.h、Ntddk.h、Ntifs.h）
IRQL	在DISPATCH_LEVEL (调用，请参阅“备注”部分) 。