WdfDpcCancel-Funktion (wdfdpc.h)

Artikel
02/27/2024

[Gilt nur für KMDF]

Die WdfDpcCancel-Methode versucht, die Ausführung der geplanten EvtDpcFunc-Rückruffunktion eines DPC-Objekts abzubrechen.

Syntax

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

Parameter

[in] Dpc

Ein Handle für ein DPC-Frameworkobjekt.

[in] Wait

Ein boolescher Wert, der bei TRUE angibt, dass die WdfDpcCancel-Methode erst zurückgegeben wird, wenn die EvtDpcFunc-Rückruffunktion des DPC-Objekts abgebrochen oder die Ausführung abgeschlossen ist. Bei FALSE wird die WdfDpcCancel-Methode sofort zurückgegeben.

Rückgabewert

WdfDpcCancel gibt TRUE zurück, wenn sich die EvtDpcFunc-Rückruffunktion des angegebenen DPC-Objekts in der DPC-Warteschlange des Systems befand. Die -Methode gibt FALSE zurück, wenn sich die Rückruffunktion nicht in der DPC-Warteschlange befand, entweder weil die Rückruffunktion ausgeführt wurde oder weil die Ausführung abgeschlossen war.

Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.

Hinweise

Wenn sich die EvtDpcFunc-Rückruffunktion des angegebenen DPC-Objekts in der DPC-Warteschlange des Systems befindet, wird sie aus der Warteschlange entfernt. Wenn sich die EvtDpcFunc-Funktion nicht in der Warteschlange befindet, wird sie entweder ausgeführt oder hat die Ausführung abgeschlossen.

Wenn der Wait-ParameterTRUE ist, muss WdfDpcCancel unter IRQL = PASSIVE_LEVEL aufgerufen werden. Wenn der Wait-Parameter FALSE ist, kann WdfDpcCancel in jedem IRQL aufgerufen werden.

Beispiele

Im folgenden Codebeispiel wird die Ausführung der Rückruffunktion abgebrochen, die dem DPC-Objekt zugeordnet ist, das im Codebeispiel im WdfDpcCreate-Thema erstellt wurde.

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

Anforderungen

Anforderung	Wert
Zielplattform	Universell
KMDF-Mindestversion	1.0
Kopfzeile	wdfdpc.h (include Wdf.h)
Bibliothek	Wdf01000.sys (siehe Versionsverwaltung der Frameworkbibliothek).)
IRQL	Weitere Informationen finden Sie im Abschnitt mit den Hinweisen.
DDI-Complianceregeln	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Weitere Informationen

EvtDpcFunc

Freigeben über