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 回呼函式，則架構會在傳遞至驅動程式的所有要求完成或取消之後呼叫它。 您可以藉由在佇列建立時間指定 WDF_OBJECT_ATTRIBUTESExecutionLevel，以修改回呼執行所在的 IRQL。 如需詳細資訊，請參閱EVT_WDF_IO_QUEUE_STATE的一節。
驅動程式不應該呼叫另一個變更佇列狀態的方法，例如 WdfIoQueuePurge 或 WdfIoQueueStart，在架構呼叫 EvtIoQueueState之前。
如果驅動程式為 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） |
| 程式庫 | Wdf01000.sys （KMDF）：WUDFx02000.dll （UMDF） |
| IRQL | <= DISPATCH_LEVEL |
| DDI 合規性規則 | ChangeQueueState（kmdf），DriverCreate（kmdf），EvtSurpriseRemoveNoSuspendQueue（kmdf），KmdfIrql （kmdf），KmdfIrql2（kmdf），KmdfIrqlExplicit（kmdf），NoCancelFromEvtSurpriseRemove（kmdf） |