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 
                );

要求

要求 值
目标平台 通用
最低 KMDF 版本 1.0
最低 UMDF 版本 2.0
标头 wdfio.h (包括 Wdf.h)
Library Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
DDI 符合性规则 ChangeQueueState (kmdf) 、 DriverCreate (kmdf) 、 EvtSurpriseRemoveNoSuspendQueue (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) ， NoCancelFromEvtSurpriseRemove (kmdf)

另请参阅

EvtIoQueueState

WdfIoQueueDrain

WdfIoQueuePurgeSynchronously