WdfIoQueueDrainSynchronously 函数 (wdfio.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfIoQueueDrainSynchronously 方法会导致框架停止对 I/O 队列的 I/O 请求排队，同时允许传递和处理已排队的请求。 方法在完成或取消所有请求后返回。

语法

void WdfIoQueueDrainSynchronously(
  [in] WDFQUEUE Queue
);

参数

[in] Queue

框架队列对象的句柄。

返回值

无

备注

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

驱动程序调用 WdfIoQueueDrainSynchronously 后，框架将停止向指定队列添加 I/O 请求。 如果框架收到对队列的其他请求，则其完成状态值为 STATUS_INVALID_DEVICE_STATE。

在返回对 WdfIoQueueDrainSynchronously 的调用之前，驱动程序不应调用另一个更改队列状态的方法，例如 WdfIoQueuePurge 或 WdfIoQueueStart。

最佳做法是，仅当确定队列的挂起 I/O 请求将及时完成时，才应调用 WdfIoQueueDrainSynchronously 。 否则，请使用 WdfIoQueuePurgeSynchronously。 有关详细信息，请参阅 管理 I/O 队列。

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

不要从以下队列对象事件回调函数调用 WdfIoQueueDrainSynchronous， 无论事件回调函数与哪个队列相关联：

EvtIoDefaultEvtIoDeviceControlEvtIoInternalDeviceControlEvtIoReadEvtIoWrite

示例

下面的代码示例将排空 I/O 队列。

WdfIoQueueDrainSynchronously(queue);

要求

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

另请参阅

WdfIoQueueDrain