WdfIoQueueDrain 函数 (wdfio.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfIoQueueDrain 方法会导致框架停止将 I/O 请求排队到 I/O 队列，同时允许传递和处理已排队的请求。

语法

void WdfIoQueueDrain(
  [in]           WDFQUEUE               Queue,
  [in, optional] PFN_WDF_IO_QUEUE_STATE DrainComplete,
  [in, optional] WDFCONTEXT             Context
);

参数

[in] Queue

框架队列对象的句柄。

[in, optional] DrainComplete

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

[in, optional] Context

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

返回值

无

备注

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

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

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

在框架调用 EvtIoQueueState 之前，驱动程序不应调用更改队列状态的其他方法，例如 WdfIoQueuePurge 或 WdfIoQueueStart。

如果驱动程序为 DrainComplete 指定 NULL，则该驱动程序可以在请求完成之前调用另一个状态更改操作。

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

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

示例

下面的代码示例将清空 I/O 队列，并在传递给驱动程序的所有请求都已完成或取消时调用驱动程序的 EvtIoQueueDrainComplete 函数。

WdfIoQueueDrain(
                Queue,
                EvtIoQueueDrainComplete,
                (WDFCONTEXT) myQueueContext
                );

要求

要求 值
目标平台 通用
最低 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

WdfIoQueueDrainSynchronously

WdfIoQueuePurge