RasGetSubEntryHandleA, fonction (ras.h)

Article
11/20/2024

La fonction RasGetSubEntryHandle récupère un handle de connexion pour une sous-entité 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 téléphonique multilink.

[in] unnamedParam2

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

[out] unnamedParam3

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

Valeur de retour

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 de Codes d’erreur d’acheminement et d’accès à distance ou Winerror.h.

Valeur	Signification
ERROR_INVALID_HANDLE	Le handle de connexion hRasConn ne représente pas une entrée de carnet 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 pour l’entrée par téléphone.

Remarques

Le handle de connexion spécifié dans le paramètre hRasConn fait référence à la connexion multilink entière, 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-ensemble dans n’importe quelle fonction qui accepte un paramètre hRasConn, RasGetConnectStatuset Fonctions 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 principal.

Vous pouvez appeler RasHangUp sur le handle retourné par RasGetSubEntryHandle pour mettre fin à un lien unique dans une connexion à plusieurs liens. 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.

Note

L’en-tête ras.h définit RasGetSubEntryHandle comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	ras.h
bibliothèque	Rasapi32.lib
DLL	Rasapi32.dll