EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2PioReceiveCleanupTransaction est appelée par la version 2 de l’extension du framework série (SerCx2) pour nettoyer l’état matériel du contrôleur série après la fin d’une transaction de réception PIO.

Syntaxe

EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION EvtSercx2PioReceiveCleanupTransaction;

void EvtSercx2PioReceiveCleanupTransaction(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

Paramètres

[in] PioReceive

Handle SERCX2PIORECEIVE à un objet de réception d’authentification unique. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2PioReceiveCreate pour créer cet objet.

Valeur de retour

Aucun

Remarques

Votre pilote de contrôleur série peut, en tant qu’option, implémenter cette fonction. Si elle est implémentée, le pilote inscrit la fonction dans l’appel à la méthode SerCx2PioReceiveCreate qui crée l’objet de réception PIO.

Votre pilote de contrôleur série doit implémenter une fonction EvtSerCx2PioReceiveCleanupTransaction si elle doit nettoyer l’état du contrôleur série à la fin d’une transaction de réception PIO. SerCx2 appelle cette fonction, si elle est implémentée, après la fin d’une transaction de réception d’authentification unique. En réponse à l’appel EvtSerCx2PioReceiveCleanupTransaction, le pilote du contrôleur série doit appeler la méthode SerCx2PioReceiveCleanupTransactionComplete pour notifier SerCx2 après le travail de nettoyage.

Pour plus d’informations, consultez SerCx2 PIO-Receive Transactions.

Exemples

Pour définir une fonction de rappel EvtSerCx2PioReceiveCleanupTransaction, vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction 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 fonctions de rappel permet d'Analyse du code pour les pilotes, static Driver Verifier (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction de rappel EvtSerCx2PioReceiveCleanupTransaction nommée MyPioReceiveCleanupTransaction, utilisez le type de fonction EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION, comme illustré dans cet exemple de code :

EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION  MyPioReceiveCleanupTransaction;

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

_Use_decl_annotations_
VOID
  MyPioReceiveCleanupTransaction(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

Le type de fonction EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION est défini dans le fichier d’en-tête Sercx.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 EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION 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 KMDF. Pour plus d’informations sur Use_decl_annotations, consultez annoter le comportement de la fonction.