RasHangUpA, fonction (ras.h)

Article
11/20/2024

La fonction RasHangUp met fin à une connexion d’accès à distance. La connexion est spécifiée avec un handle de connexion RAS. La fonction libère toutes les ressources RASAPI32.DLL associées au handle.

Syntaxe

DWORD RasHangUpA(
  [in] HRASCONN unnamedParam1
);

Paramètres

[in] unnamedParam1

Spécifie la connexion d’accès à distance à arrêter. Il s’agit d’un handle retourné par un appel précédent à RasDial ou RasEnumConnections.

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 spécifié dans hrasconn n’est pas valide.

Remarques

La connexion est arrêtée même si l’appel RasDial n’a pas encore été terminé.

Après cet appel, le handle hrasconn ne peut plus être utilisé.

Une application ne doit pas appeler RasHangUp, puis quitter immédiatement. L’ordinateur d’état de connexion a besoin de temps pour se terminer correctement. Si le système arrête prématurément l’ordinateur d’état, l’ordinateur d’état peut échouer pour fermer correctement un port, en laissant le port dans un état incohérent. En outre, une tentative immédiate d’utilisation de la même connexion peut échouer en laissant la connexion inutilisable. Un moyen simple d’éviter ces problèmes consiste à appeler veille(3000) après le retour de RasHangUp; après cette pause, l’application peut quitter. Un moyen plus réactif d’éviter ces problèmes est, après le retour de RasHangUp, pour appeler RasGetConnectStatus(hrasconn) et Veille(0) dans une boucle jusqu’à ce que RasGetConnectStatus retourne ERROR_INVALID_HANDLE.

Vous pouvez appeler RasHangUp sur le handle retourné par RasGetSubEntryHandle pour mettre fin à un lien unique dans une connexion à plusieurs liens. Toutefois, dans ce cas, vous ne pouvez pas utiliser RasGetConnectStatus pour déterminer si le lien s’est terminé ; 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 RasHangUp 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