IO_CSQ_COMPLETE_CANCELED_IRP fonction de rappel (wdm.h)

Article
03/08/2023

La routine CsqCompleteCanceledIrp est utilisée par le système pour signaler au pilote qu’il peut effectuer un IRP annulé.

Syntaxe

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

void IoCsqCompleteCanceledIrp(
  [in] PIO_CSQ Csq,
  [in] PIRP Irp
)
{...}

Paramètres

[in] Csq

Pointeur vers la structure IO_CSQ de la file d’attente cancel-safe IRP.

[in] Irp

Pointeur vers l’IRP à annuler.

Valeur de retour

None

Remarques

Le pilote spécifie la routine CsqCompleteCanceledIrp pour une file d’attente IRP cancel-safe lorsqu’il initialise la structure IO_CSQ de la file d’attente. Le pilote spécifie la routine en tant que paramètre CsqCompleteCanceledIrp de IoCsqInitialize ou IoCsqInitializeEx lorsqu’il initialise IO_CSQ. Pour plus d’informations, consultez Annuler les files d’attente IRP sécurisées.

Le système appelle cette routine pour effectuer une IRP annulée qui a été supprimée de la file d’attente du pilote. Normalement, les pilotes appellent simplement IoCompleteRequest pour l’IRP avec un status de STATUS_CANCELLED.

Les pilotes ne sont pas tenus de supprimer l’IRP de la file d’attente avant de la terminer comme annulée : le système appelle toujours la routine CsqRemoveIrp de la file d’attente pour supprimer l’IRP de la file d’attente avant d’appeler CsqCompleteCanceledIrp.

Exemples

Pour définir une routine de rappel CsqCompleteCanceledIrp , vous devez d’abord fournir une déclaration de fonction qui identifie le type de routine de rappel que vous définissez. Windows fournit un ensemble de types de fonctions de rappel pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction de rappel permet à l’analyse du code pour les pilotes, au vérificateur de pilotes statiques (SDV) et à d’autres outils de vérification de trouver des erreurs. Il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une routine de rappel CsqCompleteCanceledIrp nommée MyCsqCompleteCanceledIrp, utilisez le type IO_CSQ_COMPLETE_CANCELED_IRP comme indiqué dans cet exemple de code :

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

Ensuite, implémentez votre routine de rappel comme suit :

_Use_decl_annotations_
VOID 
 MyCsqCompleteCanceledIrp(
    _In_ PIO_CSQ  Csq,
    _In_ PIRP  Irp
    )
  {
      // Function body
  }

Le type de fonction IO_CSQ_COMPLETE_CANCELED_IRP est défini dans le fichier d’en-tête Wdm.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation _Use_decl_annotations_ à votre définition de fonction. L’annotation _Use_decl_annotations_ garantit que les annotations appliquées au type de fonction IO_CSQ_COMPLETE_CANCELED_IRP dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes WDM. Pour plus d’informations sur _Use_decl_annotations_, consultez Annotating Function Behavior.