EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2PioReceiveCancelReadyNotification est appelée par la version 2 de l’extension de framework série (SerCx2) pour annuler une notification prête activée par SerCx2 lors d’un appel précédent à la fonction de rappel d’événement EvtSerCx2PioReceiveEnableReadyNotification.

Syntaxe

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION EvtSercx2PioReceiveCancelReadyNotification;

BOOLEAN EvtSercx2PioReceiveCancelReadyNotification(
  [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

La fonction EvtSerCx2PioReceiveCancelReadyNotification retourne TRUE si la notification prête a été correctement désactivée et que le pilote du contrôleur série peut garantir que cette notification n’entraîne pas l’appel de la méthode SerCx2PioReceiveReady. La fonction retourne FALSE si le pilote a déjà appelé SerCx2PioReceiveReady, ou est sur le point d’appeler cette méthode.

Remarques

Votre pilote de contrôleur série doit implémenter cette fonction. Le pilote inscrit la fonction dans l’appel SerCx2PioReceiveCreate qui crée l’objet de réception PIO.

Si la demande de lecture associée expire ou est annulée lorsqu’une notification prête est activée, SerCx2 appelle la EvtSerCx2PioReceiveCancelReadyNotification fonction pour annuler la notification en attente. Si cet appel retourne FAUX, SerCx2 s’attend à ce que le pilote du contrôleur série appelle SerCx2PioReceiveReady; Seulement après cet appel, SerCx2 appelle la fonction de rappel d’événement EvtSerCx2PioReceiveCleanupTransaction, si elle est implémentée et termine la requête.

Pour annuler la notification prête, la fonction EvtSerCx2PioReceiveCancelReadyNotification désactive généralement l’interruption dans le contrôleur série qui indique que d’autres données sont disponibles pour être lues à partir du FIFO de réception. Cette interruption a été activée par un appel précédent à la fonction EvtSerCx2PioReceiveEnableReadyNotification.

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

Exemples

Pour définir une EvtSerCx2PioReceiveCancelReadyNotification 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 EvtSerCx2PioReceiveCancelReadyNotification fonction de rappel nommée MyPioReceiveCancelReadyNotification, utilisez le type de fonction EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION, comme illustré dans cet exemple de code :

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION  MyPioReceiveCancelReadyNotification;

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

_Use_decl_annotations_
BOOLEAN
  MyPioReceiveCancelReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

Le type de fonction EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION 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_CANCEL_READY_NOTIFICATION 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.