WdfIoQueuePurge 函数 （wdfio.h）

[适用于 KMDF 和 UMDF]

WdfIoQueuePurge 方法会导致框架停止对 I/O 队列的 I/O 请求进行排队，并取消未处理的请求。

语法

void WdfIoQueuePurge(
  [in]           WDFQUEUE               Queue,
  [in, optional] PFN_WDF_IO_QUEUE_STATE PurgeComplete,
  [in, optional] WDFCONTEXT             Context
);

参数

[in] Queue

框架队列对象的句柄。

[in, optional] PurgeComplete

指向驱动程序提供的 EvtIoQueueState 回调函数的指针。 此参数是可选的，可以 NULL。

[in, optional] Context

框架传递给 EvtIoQueueState 回调函数的驱动程序提供的上下文信息的非类型化指针。 此参数是可选的，可以 NULL。

返回值

没有

注解

如果驱动程序提供无效的对象句柄，则会发生 bug 检查。

驱动程序调用 WdfIoQueuePurge后，框架将停止向指定队列添加 I/O 请求。 框架 取消 尚未传递到目标设备的所有请求，并为每个请求调用驱动程序的 CompletionRoutine 回调函数。 该框架还尝试取消（通过调用 IoCancelIrp）发送到未标记为 WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE的目标设备的任何请求。

如果框架收到队列的其他请求，则会使用完成状态值完成队列STATUS_INVALID_DEVICE_STATE。

如果驱动程序提供 EvtIoQueueState 回调函数，则框架会在传递到驱动程序的所有请求完成或取消后调用该函数。 可以通过在队列创建时在 WDF_OBJECT_ATTRIBUTES 中指定 ExecutionLevel 来修改回调运行所在的 IRQL。 有关详细信息，请参阅EVT_WDF_IO_QUEUE_STATE的“备注”部分。

驱动程序清除 I/O 队列后，可以通过调用 WdfIoQueueStart来重启队列。

如果驱动程序在调用 WdfIoQueuePurge后调用 WdfRequestRequeue，则重新排队尝试可能会在清除完成之前成功。 在 1.9 版和更早版本的 KMDF 中，此序列会导致作系统崩溃。 KMDF 版本 1.11 及更高版本中已修复此问题。

有关 WdfIoQueuePurge 方法的详细信息，请参阅 管理 I/O 队列。

例子

下面的代码示例清除 I/O 队列，并且当传递到驱动程序的所有请求都已完成或取消时，不会调用回调函数。

WdfIoQueuePurge(
                ReadQueue, 
                WDF_NO_EVENT_CALLBACK, 
                WDF_NO_CONTEXT 
                );

要求

另请参阅

EvtIoQueueState

WdfIoQueueDrain

WdfIoQueuePurgeSynchronously