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

要求

另请参阅

EvtIoCanceledOnQueue

EvtIoQueueState

WdfIoQueueStart

WdfIoQueueStopAndPurgeSynchronously