WdfDpcCancel 函式 (wdfdpc.h)

  • 發行項

[僅適用於 KMDF]

WdfDpcCancel 方法會嘗試取消執行 DPC 物件的排程 EvtDpcFunc 回呼函式。

語法

BOOLEAN WdfDpcCancel(
  [in] WDFDPC  Dpc,
  [in] BOOLEAN Wait
);

參數

[in] Dpc

架構 DPC 物件的句柄。

[in] Wait

布爾值，如果 為 TRUE，表示 WdfDpcCancel 方法將不會傳回，直到 DPC 物件的 EvtDpcFunc 回呼函式取消或完成執行為止。 如果 為FALSE，WdfDpcCancel 方法會立即傳回。

傳回值

如果指定的 DPC 物件的 EvtDpcFunc 回呼函式位於系統的 DPC 佇列中，WdfDpcCancel 會傳回 TRUE。 如果回呼函式不在 DPC 佇列中，則方法會傳回 FALSE ，可能是因為回呼函式正在執行，或是它已完成執行。

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

備註

如果指定的 DPC 物件的 EvtDpcFunc 回呼函式位於系統的 DPC 佇列中，則會從佇列中移除。 如果 EvtDpcFunc 函式不在佇列中，則會執行或已完成執行。

如果 Wait 參數為 TRUE，則必須在 IRQL = PASSIVE_LEVEL呼叫 WdfDpcCancel 。 如果 Wait 參數為 FALSE，可以在任何 IRQL 呼叫 WdfDpcCancel 。

範例

下列程式代碼範例會取消與 WdfDpcCreate 主題中程式代碼範例建立之 DPC 對象相關聯的回呼函式執行。

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

規格需求

需求 值
目標平台 Universal
最低 KMDF 版本 1.0
標頭 wdfdpc.h (包含 Wdf.h)
程式庫 Wdf01000.sys (請參閱 Framework Library Versioning.)
IRQL 請參閱一節。
DDI 合規性規則 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另請參閱

EvtDpcFunc