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 要求新增至指定的佇列。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

範例

下列程式代碼範例會停止並清除指定的 I/O 佇列。 在傳遞至驅動程式的所有要求都已完成或取消之後，架構會呼叫驅動程式的 EvtIoQueueStateStopAndPurge 函式。

WDFCONTEXT stopandpurgeContext;

stopandpurgeContext = &myContext;

WdfIoQueueStopAndPurge(
               queue,
               EvtIoQueueStateStopAndPurge,
               stopandpurgeContext
               );

規格需求

另請參閱

EvtIoCanceledOnQueue

EvtIoQueueState

WdfIoQueueStart

WdfIoQueueStopAndPurgeSynchronously