EVT_SERCX2_FILEOPEN fonction de rappel (sercx.h)

La fonction de rappel d’événements EvtSerCx2FileOpen est appelée par la version 2 de l’extension du framework série (SerCx2) pour avertir le pilote du contrôleur série qu’un client a ouvert une connexion logique à l’appareil du contrôleur série et qu’un objet de fichier a été créé pour représenter cette connexion.

Syntaxe

EVT_SERCX2_FILEOPEN EvtSercx2Fileopen;

NTSTATUS EvtSercx2Fileopen(
  [in] WDFDEVICE Device
)
{...}

Paramètres

[in] Device

Handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur série. Le pilote de contrôleur série a créé cet objet dans sa fonction de rappel EvtDriverDeviceAdd. Pour plus d’informations, consultez SerCx2InitializeDevice.

Valeur de retour

La fonction EvtSerCx2FileOpen retourne STATUS_SUCCESS si l’appel réussit. Sinon, elle retourne un code d’état d’erreur approprié.

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 cette fonction dans l’appel à l'SerCx2InitializeDevice méthode qui termine l’initialisation de l’objet d’appareil framework pour le contrôleur série. SerCx2 appelle la fonction EvtSerCx2FileOpen lorsqu’un pilote client ouvre un handle de fichier dans la pile des pilotes du contrôleur série.

Pour plus d’informations, consultez Framework File Objects.

Exemples

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

EVT_SERCX2_FILEOPEN  MyFileOpen;

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

_Use_decl_annotations_
NTSTATUS
  MyFileOpen(
    WDFDEVICE  Device
    )
  {...}

Le type de fonction EVT_SERCX2_FILEOPEN 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_FILEOPEN 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.

Exigences

Voir aussi

SerCx2InitializeDevice