Fonction RasGetSubEntryHandleA (ras.h)

Article
03/04/2024

La fonction RasGetSubEntryHandle récupère un handle de connexion pour une sous-entrée spécifiée d’une connexion multilink.

Syntaxe

DWORD RasGetSubEntryHandleA(
  [in]  HRASCONN   unnamedParam1,
  [in]  DWORD      unnamedParam2,
  [out] LPHRASCONN unnamedParam3
);

Paramètres

[in] unnamedParam1

Spécifie le handle de connexion HRASCONN retourné par la fonction RasDial pour une entrée d’annuaire téléphonique multilink.

[in] unnamedParam2

Spécifie un index de sous-entrée valide pour l’entrée de l’annuaire téléphonique.

[out] unnamedParam3

Pointeur vers la variable HRASCONN qui reçoit un handle de connexion qui représente la connexion de sous-entrée.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants ou une valeur provenant des codes d’erreur de routage et d’accès à distance ou de Winerror.h.

Valeur	Signification
ERROR_INVALID_HANDLE	Le handle de connexion hRasConn ne représente pas une entrée d’annuaire téléphonique connectée.
ERROR_PORT_NOT_OPEN	Les paramètres hRasConn et dwSubEntry sont valides, mais la sous-entrée spécifiée n’est pas connectée.
ERROR_NO_MORE_ITEMS	La valeur spécifiée par dwSubEntry dépasse le nombre maximal de sous-entrées de l’annuaire téléphonique.

Remarques

Le handle de connexion spécifié dans le paramètre hRasConn fait référence à l’ensemble de la connexion multilink, mais le handle de connexion retourné dans le paramètre *lphRasConn fait uniquement référence à la connexion de sous-entrée. Utilisez le handle de connexion de sous-entrée dans toute fonction qui accepte un paramètre hRasConn , y compris les fonctions RasHangUp, RasGetConnectStatus et RasGetProjectionInfoEx . Les informations de projection retournées par RasGetProjectionInfo pour une entrée multilink sont les mêmes pour chacun des handles de connexion de sous-entrée que pour le handle de connexion main.

Vous pouvez appeler RasHangUp sur le handle retourné par RasGetSubEntryHandle pour mettre fin à un lien unique dans une connexion multi-liaison. Toutefois, vous ne pouvez pas utiliser RasGetConnectStatus pour déterminer si le lien s’est arrêté ; RasGetConnectStatus peut ne pas retourner ERROR_INVALID_HANDLE même si le lien s’est terminé avec succès.

Notes

L’en-tête ras.h définit RasGetSubEntryHandle comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ras.h
Bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll