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。

傳回值

無

備註

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

驅動程式呼叫 WdfIoQueueDrain 之後，架構會停止將 I/O 要求新增至指定的佇列。 如果架構收到佇列的其他要求，則會以完成狀態值為 STATUS_INVALID_DEVICE_STATE完成這些要求。

如果驅動程式提供 EvtIoQueueState 回呼函式，架構會在傳遞至驅動程式的所有要求完成或取消之後呼叫它。 您可以在建立佇列時指定 executionLevelWDF_OBJECT_ATTRIBUTES ，以修改回呼執行所在的 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
                );

規格需求

另請參閱

EvtIoQueueState

WdfIoQueueDrainSynchronously

WdfIoQueuePurge