EVT_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION fonction de rappel (sercx.h)

Article
10/30/2024

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

Syntaxe

EVT_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION EvtSercx2PioTransmitCleanupTransaction;

void EvtSercx2PioTransmitCleanupTransaction(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

Paramètres

[in] PioTransmit

Handle SERCX2PIOTRANSMIT à un objet de transmission PIO. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2PioTransmitCreate 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. S’il est implémenté, le pilote inscrit la fonction dans le SerCx2PioTransmitCreate appel qui crée l’objet de transmission PIO.

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

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

Exemples

Pour définir une fonction de rappel EvtSerCx2PioTransmitCleanupTransaction fonction de rappel, 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 EvtSerCx2PioTransmitCleanupTransaction appelée MyPioTransmitCleanupTransaction, utilisez le type de fonction EVT_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION, comme illustré dans cet exemple de code :

EVT_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION  MyPioTransmitCleanupTransaction;

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

_Use_decl_annotations_
VOID
  MyPioTransmitCleanupTransaction(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

Le type de fonction EVT_SERCX2_PIO_TRANSMIT_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_TRANSMIT_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.