WdfIoQueueDrainSynchronously 函式 (wdfio.h)

  • 發行項

[適用於 KMDF 和 UMDF]

WdfIoQueueDrainSynchronously 方法會使架構停止將 I/O 要求排入佇列至 I/O 佇列，同時允許傳遞和處理已排入佇列的要求。 方法會在完成或取消所有要求之後傳回。

語法

void WdfIoQueueDrainSynchronously(
  [in] WDFQUEUE Queue
);

參數

[in] Queue

架構佇列物件的句柄。

傳回值

無

備註

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

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

在呼叫 WdfIoQueueDrainSynchronously 之前，驅動程式不應該呼叫另一個變更佇列狀態的方法，例如 WdfIoQueuePurge 或 WdfIoQueueStart。

最佳做法是，當您確定佇列的擱置 I/O 要求會及時完成時，您應該只呼叫 WdfIoQueueDrainSynchronously 。 否則，請使用 WdfIoQueuePurgeSynchronously。 如需詳細資訊，請參閱 管理 I/O 佇列。

驅動程式清空 I/O 佇列之後，可以藉由呼叫 WdfIoQueueStart 來重新啟動佇列。

請勿從下列佇列物件事件回呼函式呼叫 WdfIoQueueDrainSynchronously ，不論事件回呼函式相關聯的佇列為何：

EvtIoDefaultEvtIoDeviceControlEvtIoInternalDeviceControlEvtIoReadEvtIoWrite

範例

下列程式代碼範例會清空 I/O 佇列。

WdfIoQueueDrainSynchronously(queue);

規格需求

需求 值
目標平台 Universal
最低 KMDF 版本 1.0
最低UMDF版本 2.0
標頭 wdfio.h (包含 Wdf.h)
程式庫 Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
DDI 合規性規則 ChangeQueueState (kmdf) ， DriverCreate (kmdf) ， EvtSurpriseRemoveNoSuspendQueue (kmdf ) ， KmdfIrql (kmdf ) ， KmdfIrql2 (kmdf) ， KmdfIrqlExplicit (kmdf) ， NoCancelFromEvtSurpriseRemove (kmdf)

另請參閱

WdfIoQueueDrain