Fonction RasGetConnectStatusA (ras.h)

  • Article

La fonction RasGetConnectStatus récupère des informations sur la status actuelle de la connexion d’accès à distance spécifiée. Une application peut utiliser cet appel pour déterminer quand un appel RasDial asynchrone est terminé.

Syntaxe

DWORD RasGetConnectStatusA(
  [in]      HRASCONN         unnamedParam1,
  [in, out] LPRASCONNSTATUSA unnamedParam2
);

Paramètres

[in] unnamedParam1

Spécifie la connexion d’accès à distance pour laquelle récupérer le status. Ce handle doit avoir été obtenu à partir de RasDial ou RasEnumConnections.

[in, out] unnamedParam2

Pointeur vers la structure RASCONNSTATUS qui, en sortie, reçoit les informations status.

Lors de l’entrée, définissez le membre dwSize de la structure sur sizeof(RASCONNSTATUS) afin d’identifier la version de la structure transmise.

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_NOT_ENOUGH_MEMORY
 La fonction n’a pas pu allouer suffisamment de mémoire pour terminer l’opération.

Remarques

La valeur de retour de RasGetConnectStatus n’est pas nécessairement égale à la valeur du membre dwError de la structure RASCONNSTATUS retournée par RasGetConnectStatus. La valeur de retour de RasGetConnectStatus indique des erreurs qui se produisent pendant l’appel de la fonction RasGetConnectStatus , tandis que le membre dwError indique les erreurs qui ont empêché l’établissement de la connexion.

Notes

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

Voir aussi

RASCONNSTATUS

RasDial

RasEnumConnections

Vue d’ensemble du service d’accès à distance (RAS)

Fonctions du service d’accès à distance