WdfDpcCancel, fonction (wdfdpc.h)

[S’applique uniquement à KMDF]

La méthode WdfDpcCancel tente d’annuler l’exécution d’une fonction de rappel planifiée d’un objet DPC EvtDpcFunc.

Syntaxe

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

Paramètres

[in] Dpc

Handle d’un objet DPC framework.

[in] Wait

Valeur booléenne qui, si TRUE, indique que la méthode WdfDpcCancel ne retourne pas tant que la fonction de rappel EvtDpcFunc de l’objet DPC n’est pas annulée ou terminée. Si FALSE, la méthode WdfDpcCancel retourne immédiatement.

Valeur de retour

WdfDpcCancel retourne TRUE si la fonction de rappel EvtDpcFun c spécifiée était dans la file d’attente DPC du système. La méthode retourne FAUX si la fonction de rappel n’était pas dans la file d’attente DPC, soit parce que la fonction de rappel s’exécutait, soit parce qu’elle avait terminé l’exécution.

Une vérification de bogue se produit si le pilote fournit un handle d’objet non valide.

Remarques

Si la fonction de rappel de l’objet DPC spécifié EvtDpcFunc se trouve dans la file d’attente DPC du système, elle est supprimée de la file d’attente. Si la fonction EvtDpcFunc n’est pas dans la file d’attente, elle est en cours d’exécution ou s’est terminée.

Si le paramètre Wait est TRUE, WdfDpcCancel doit être appelé à IRQL = PASSIVE_LEVEL. Si le paramètre Wait est FALSE, WdfDpcCancel peut être appelé à n’importe quel irQL.

Exemples

L’exemple de code suivant annule l’exécution de la fonction de rappel associée à l’objet DPC que l’exemple de code dans la rubrique WdfDpcCreate créée.

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

Spécifications

Besoin	Valeur
plateforme cible	Universel
version minimale de KMDF	1.0
En-tête	wdfdpc.h (include Wdf.h)
Bibliothèque	Wdf01000.sys (voir Versioning de la bibliothèque Framework.)
IRQL	Voir la section Remarques.
règles de conformité DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Voir aussi

EvtDpcFunc