IO_CSQ_PEEK_NEXT_IRP fonction de rappel (wdm.h)

Article
02/29/2024

La routine CsqPeekNextIrp est utilisée par le système pour rechercher la prochaine IRP correspondante dans une file d’attente IRP d’annulation sécurisée implémentée par le pilote.

Syntaxe

IO_CSQ_PEEK_NEXT_IRP IoCsqPeekNextIrp;

PIRP IoCsqPeekNextIrp(
  [in]           PIO_CSQ Csq,
  [in, optional] PIRP Irp,
  [in, optional] PVOID PeekContext
)
{...}

Paramètres

[in] Csq

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

[in, optional] Irp

Pointeur vers un IRP dans la file d’attente IRP du pilote ou NULL pour spécifier le début de la file d’attente.

[in, optional] PeekContext

Pointeur vers les informations de contexte définies par le pilote. La routine CsqPeekNextIrp retourne le premier IRP qui suit Irp et correspond à PeekContext.

Valeur retournée

CsqPeekNextIrp retourne le premier IRP qui suit Irp dans la file d’attente et correspond à PeekContext, ou NULL s’il n’y a pas d’IRP correspondant. Si Irp a la valeur NULL, CsqPeekNextIrp retourne le premier IRP correspondant dans la file d’attente, ou NULL s’il n’y a pas d’IRP correspondant.

Remarques

Le pilote spécifie la routine CsqPeekNextIrp 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 comme paramètre CsqPeekNextIrpd’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 utilise CsqPeekNextIrp pour itérer à travers les IRPs dans la file d’attente IRP du pilote. Par exemple, la routine IoCsqRemoveNextIrp utilise cette routine pour rechercher l’IRP à supprimer.

Exemples

Pour définir une routine de rappel CsqPeekNextIrp , 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 aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’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 CsqPeekNextIrp nommée MyCsqPeekNextIrp, utilisez le type IO_CSQ_PEEK_NEXT_IRP comme indiqué dans cet exemple de code :

IO_CSQ_PEEK_NEXT_IRP MyCsqPeekNextIrp;

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

_Use_decl_annotations_
PIRP 
 MyCsqPeekNextIrp(
    PIO_CSQ  Csq,
    PIRP  Irp,
    PVOID  PeekContext
    )
  {
      // Function body
  }

Le type de fonction IO_CSQ_PEEK_NEXT_IRP est défini dans le fichier d’en-tête Wdm.h. Pour identifier plus précisément les erreurs lorsque vous exécutez les 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_PEEK_NEXT_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.