EVT_SPB_TARGET_CONNECT fonction de rappel (spbcx.h)
La fonction de rappel d’événement evtSpbTargetConnect du pilote de contrôleur SPB ouvre une connexion à un appareil cible sur le bus.
Syntaxe
EVT_SPB_TARGET_CONNECT EvtSpbTargetConnect;
NTSTATUS EvtSpbTargetConnect(
[in] WDFDEVICE Controller,
[in] SPBTARGET Target
)
{...}
Paramètres
[in] Controller
Handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur SPB.
[in] Target
Un handle SPBTARGET à la cible à ouvrir. La cible est un périphérique ou un port attaché au bus.
Valeur de retour
EvtSpbTargetConnect retourne STATUS_SUCCESS si le pilote ouvre correctement la connexion à la cible. Sinon, la fonction retourne un code d’erreur NTSTATUS approprié.
Remarques
L’implémentation de cette fonction par le pilote du contrôleur SPB est facultative.
L’extension de framework SPB (SpbCx) gère la file d’attente d’E/S pour le contrôleur SPB. Si le pilote du contrôleur SPB inscrit une fonction de rappel EvtSpbTargetConnect, SpbCx appelle cette fonction lorsqu’un client (pilote périphérique) du contrôleur envoie une demande IRP_MJ_CREATE pour ouvrir une connexion à un appareil cible sur le bus. Si la fonction EvtSpbTargetConnect retourne un code d’erreur, SpbCx échoue à la requête IRP_MJ_CREATE. Un client qui ouvre correctement une connexion à une cible a un accès exclusif à la cible jusqu’à ce que la connexion soit fermée.
Appelez la méthode SpbTargetGetConnectionParameters pour obtenir les paramètres de connexion de l’appareil cible. Un pilote de contrôleur SPB appelle généralement cette méthode à partir de la fonction EvtSpbTargetConnect du pilote. SpbTargetGetConnectionParameters écrit les paramètres de connexion dans une structure de SPB_CONNECTION_PARAMETERS fournie par l’appelant. Le ConnectionParameters membre de cette structure est un pointeur vers une mémoire tampon qui contient les paramètres de connexion de l’appareil cible. Le pilote utilise ces paramètres pour configurer le contrôleur SPB pour communiquer avec l’appareil. Pour plus d’informations, consultez Comment obtenir les paramètres de connexion d’un appareil.
La fonction de rappel EvtSpbTargetConnect est appelée de façon synchrone à partir du contexte du thread client qui demande la connexion à la cible.
SpbCx appelle la fonction de rappel EvtSpbTargetDisconnect pour fermer une connexion cible précédemment ouverte par un rappel EvtSpbTargetConnect.
Pour inscrire une fonction de rappel EvtSpbTargetConnect, appelez la méthode SpbDeviceInitialize.
Exemples
Pour définir une fonction de rappel EvtSpbTargetConnect, 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 EvtSpbTargetConnect nommée MyEvtSpbTargetConnect, utilisez le type de fonction EVT_SPB_TARGET_CONNECT, comme illustré dans cet exemple de code :
EVT_SPB_TARGET_CONNECT MyEvtSpbTargetConnect;
Ensuite, implémentez votre fonction de rappel comme suit :
_Use_decl_annotations_
NTSTATUS
MyEvtSpbTargetConnect(
WDFDEVICE Controller,
SPBTARGET Target
)
{ ... }
Le type de fonction EVT_SPB_TARGET_CONNECT est défini dans le fichier d’en-tête Spbcx.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_SPB_TARGET_CONNECT 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
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Prise en charge à partir de Windows 8. |
| plateforme cible | Bureau |
| d’en-tête | spbcx.h |
| IRQL | Appelé à PASSIVE_LEVEL. |