wdfIoQueuePurge 函式 (wdfio.h)

[適用於 KMDF 和 UMDF]

WdfIoQueuePurge 方法會使架構停止將 I/O 要求排入 I/O 佇列,並取消未處理的要求。

語法

void WdfIoQueuePurge(
  [in]           WDFQUEUE               Queue,
  [in, optional] PFN_WDF_IO_QUEUE_STATE PurgeComplete,
  [in, optional] WDFCONTEXT             Context
);

參數

[in] Queue

架構佇列物件的句柄。

[in, optional] PurgeComplete

驅動程式提供的 EvtIoQueueState 回呼函式的指標。 這個參數是選擇性的,而且可以是 NULL

[in, optional] Context

驅動程式提供之內容資訊的不具型別指標,架構會傳遞至 EvtIoQueueState 回呼函式。 這個參數是選擇性的,而且可以是 NULL

傳回值

備註

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

驅動程式呼叫 WdfIoQueuePurge 之後,架構會停止將 I/O 要求新增至指定的佇列。 架構 會取消 其未傳遞至目標裝置的所有要求,並針對每個要求呼叫驅動程式的 CompletionRoutine 回呼函式。 架構也會透過呼叫 IoCancelIrp 來嘗試取消 (,) 傳遞至未標示 WDF_REQUEST_SEND_OPTION_IGNORE_TARGET_STATE目標裝置的任何要求。

如果架構收到佇列的其他要求,它會以完成狀態值為 STATUS_INVALID_DEVICE_STATE 來完成這些要求。

如果驅動程式提供 EvtIoQueueState 回呼函式,則架構會在傳遞至驅動程式的所有要求都已完成或取消之後呼叫它。 您可以在佇列建立時指定 executionLevelWDF_OBJECT_ATTRIBUTES ,以修改回呼執行所在的 IRQL。 如需詳細資訊,請參閱EVT_WDF_IO_QUEUE_STATE的一節。

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

如果驅動程式在呼叫 WdfIoQueuePurge 之後呼叫 WdfRequestRequeue,重新佇列嘗試可能會在清除完成之前成功。 在 1.9 版和更早版本的 KMDF 中,此順序會導致操作系統當機。 KMDF 1.11 版和更新版本中已修正此問題。

如需 WdfIoQueuePurge 方法的詳細資訊,請參閱 管理 I/O 佇列

範例

下列程式代碼範例會清除 I/O 佇列,而且在傳遞至驅動程式的所有要求都已完成或取消時,不會呼叫回呼函式。

WdfIoQueuePurge(
                ReadQueue, 
                WDF_NO_EVENT_CALLBACK, 
                WDF_NO_CONTEXT 
                );

規格需求

需求
目標平台 Universal
最低 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)

另請參閱

EvtIoQueueState

WdfIoQueueDrain

WdfIoQueuePurgeSynchronously