WdfIoQueueStopAndPurge 函数 (wdfio.h)

  • 项目

[适用于 KMDF 和 UMDF]

WdfIoQueueStopAndPurge 方法阻止 I/O 队列传递新请求，并取消现有的未处理请求和驱动程序拥有的可取消请求，但队列接收并存储新请求。

语法

void WdfIoQueueStopAndPurge(
  [in]           WDFQUEUE               Queue,
  [in, optional] PFN_WDF_IO_QUEUE_STATE StopAndPurgeComplete,
  [in, optional] WDFCONTEXT             Context
);

参数

[in] Queue

框架队列对象的句柄。

[in, optional] StopAndPurgeComplete

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

[in, optional] Context

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

返回值

无

备注

WdfIoQueueStopAndPurge 方法阻止 I/O 队列向驱动程序传递 I/O 请求，同时允许将新请求添加到队列。

此外，它会取消队列中的未处理请求，以及驱动程序拥有的可取消请求 (传递给驱动程序的请求（驱动程序尚未完成或重新排队) ）。 如果在 WdfIoQueueStopAndPurge 正在进行时添加新请求，则在驱动程序调用 WdfIoQueueStart 之前不会传递这些新请求。

相比之下， WdfIoQueueStop 方法不会取消队列中未处理的请求或驱动程序拥有的可取消请求。

如果此方法导致框架取消队列中的未处理请求，则框架会为该队列调用驱动程序的 EvtIoCanceledOnQueue 回调函数（如果驱动程序已提供该函数）。

如果驱动程序提供 EvtIoQueueState 回调函数，框架会在传递给驱动程序的所有请求都已完成或取消后调用它。

WdfIoQueueStopAndPurge 方法使队列能够接收新请求，即使队列在名为 WdfIoQueueStopAndPurge 的驱动程序之前未收到新请求。 例如，驱动程序可能会调用 WdfIoQueueDrain，这会导致框架停止向队列添加新 I/O 请求。 驱动程序后续调用 WdfIoQueueStopAndPurge 会导致框架继续向队列添加请求。

相比之下， WdfIoQueuePurge 会导致框架停止向指定队列添加 I/O 请求。

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

示例

下面的代码示例停止并清除指定的 I/O 队列。 完成或取消传递给驱动程序的所有请求后，框架将调用驱动程序的 EvtIoQueueStateStopAndPurge 函数。

WDFCONTEXT stopandpurgeContext;

stopandpurgeContext = &myContext;

WdfIoQueueStopAndPurge(
               queue,
               EvtIoQueueStateStopAndPurge,
               stopandpurgeContext
               );

要求

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

另请参阅

EvtIoCanceledOnQueue

EvtIoQueueState

WdfIoQueueStart

WdfIoQueueStopAndPurgeSynchronously