WdfDpcCancel-Funktion (wdfdpc.h)

[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
);

Die Parameter

[in] Dpc

Ein Handle zu einem Framework-DPC-Objekt.

[in] Wait

Ein boolescher Wert, der, wenn TRUE, angibt, dass die WdfDpcCancel--Methode erst zurückgegeben wird, wenn die EvtDpcFunc- Rückruffunktion abgebrochen oder ausgeführt wird. Wenn FALSE-, gibt die WdfDpcCancel Methode sofort zurück.

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 sie die Ausführung beendet hatte.

Wenn der Treiber ein ungültiges Objekthandle bereitstellt, tritt eine Fehlerüberprüfung auf.

Bemerkungen

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

Wenn der parameter WaitTRUEist, muss WdfDpcCancel bei IRQL = PASSIVE_LEVEL aufgerufen werden. Wenn der parameter WaitFALSEist, kann WdfDpcCancel bei 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

Siehe auch

EvtDpcFunc