Fonction NdisCoGetTapiCallId (ndis.h)

  • Article

NdisCoGetTapiCallId récupère une chaîne que les applications TAPI peuvent utiliser pour identifier une connexion virtuelle NDIS particulière.

Syntaxe

NDIS_STATUS NdisCoGetTapiCallId(
  [in]      NDIS_HANDLE NdisVcHandle,
  [in, out] PVAR_STRING TapiCallId
);

Paramètres

[in] NdisVcHandle

Spécifie le handle NDIS pour le vc. Ce handle a été fourni par NDIS lorsque le vc a été créé à l’origine avec la fonction NdisCoCreateVc .

[in, out] TapiCallId

Pointeur vers une mémoire tampon allouée à l’appelant qui reçoit une structure de données de type VAR_STRING. Une fois le retour réussi, cette structure décrit une chaîne que les applications TAPI peuvent utiliser pour identifier le vc.

Valeur retournée

Retourne l’une des valeurs status suivantes :

Code de retour Description
NDIS_STATUS_SUCCESS
 NDIS a correctement retourné un identificateur de chaîne pour le vc.
NDIS_STATUS_BUFFER_TOO_SHORT
 Le membre ulTotalSize de la structure VAR_STRING spécifie que la taille de la mémoire tampon n’est pas suffisamment grande pour contenir la chaîne qui identifie le vc. NdisCoGetTapiCallId définit le membre ulNeededSize de la structure VAR_STRING à la taille requise en octets.
NDIS_STATUS_INVALID_DATA
 Le handle du vc spécifié par NdisVcHandle n’est pas valide.

Remarques

Supposons qu’un gestionnaire d’appels appelle NdisCoCreateVc pour créer un vc pour un appel TAPI. NDIS fournit à son tour le handle au vc à un client. Le client transmet ce handle VC dans un appel à la fonction NdisCoGetTapiCallId pour récupérer une chaîne qui identifie le vc. Le client peut passer cet identificateur de chaîne à une application TAPI pour identifier le vc.

Le client crée un contexte pour chaque vc qu’il gère. Le client utilise NdisCoGetTapiCallId pour récupérer un identificateur de chaîne pour chaque VC. Le client transmet chaque identificateur de chaîne à une application TAPI pour identifier chaque VC. Plus tard, si une application TAPI transmet l’un de ces identificateurs de chaîne au client dans une opération liée à vc, le client doit passer cet identificateur de chaîne en tant que chaîne Unicode dans un appel à NdisClGetProtocolVcContextFromTapiCallId pour récupérer le contexte correct pour le vc.

Pour plus d’informations sur la structure VAR_STRING, consultez Objets TAPI.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Pris en charge pour les pilotes NDIS 6.0 et NDIS 5.1 (consultez NdisCoGetTapiCallId (NDIS 5.1)) dans Windows Vista. Pris en charge pour les pilotes NDIS 5.1 (consultez NdisCoGetTapiCallId (NDIS 5.1)) dans Windows XP.
Plateforme cible Desktop (Expérience utilisateur)
En-tête ndis.h (inclure Ndis.h)
Bibliothèque Ndis.lib
IRQL DISPATCH_LEVEL
Règles de conformité DDI Irql_Connection_Function(ndis)

Voir aussi

NdisClGetProtocolVcContextFromTapiCallId

NdisCoCreateVc