RasEnumConnectionsA, fonction (ras.h)

La fonction RasEnumConnections répertorie toutes les connexions RAS actives. Elle retourne le handle de chaque connexion et le nom de l’entrée de carnet téléphonique.

Syntaxe

DWORD RasEnumConnectionsA(
  [in, out] LPRASCONNA unnamedParam1,
  [in, out] LPDWORD    unnamedParam2,
  [out]     LPDWORD    unnamedParam3
);

Paramètres

[in, out] unnamedParam1

Pointeur vers une mémoire tampon qui reçoit, en sortie, un tableau de structures RASCONN, une pour chaque connexion RAS.

Lors de l’entrée, une application doit définir la dwSize membre du premier structure RASCONN dans la mémoire tampon sur sizeof(RASCONN) afin d’identifier la version de la structure passée.

[in, out] unnamedParam2

Pointeur vers une variable qui, en entrée, contient la taille, en octets, de la mémoire tampon spécifiée par lprasconn.

En sortie, la fonction définit cette variable sur le nombre d’octets requis pour énumérer les connexions RAS.

note   

Pour déterminer la taille de mémoire tampon requise, appelez RasEnumConnections avec lprasconn défini sur NULL. La variable pointée par lpcb doit être définie sur zéro. La fonction retourne la taille de mémoire tampon requise dans lpcb et un code d’erreur de ERROR_BUFFER_TOO_SMALL.

 

[out] unnamedParam3

Pointeur vers une variable qui reçoit le nombre de structures RASCONN écrites dans la mémoire tampon spécifiée par lprasconn.

Valeur de retour

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

Si la fonction échoue, la valeur de retour provient de codes d’erreur de routage et d’accès à distance ou Winerror.h.

Retourner le code	Description
ERROR_BUFFER_TOO_SMALL	La mémoire tampon lprasconn n’est pas suffisamment grande. Le paramètre lpcb est inférieur au membre dwSize dans le paramètre lprasconn qui doit être défini avant d’appeler la fonction. La fonction retourne la taille de mémoire tampon requise dans la variable pointée par lpcb.

Remarques

Si une connexion a été établie sans spécifier de nom d’entrée de carnet téléphonique, les informations retournées pour cette connexion donnent le numéro de téléphone de connexion précédé de « ».

L’exemple de code suivant utilise RasEnumConnections pour énumérer les connexions RAS actives.

#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "raserror.h"
#pragma comment(lib, "rasapi32.lib")

DWORD __cdecl wmain(){

    DWORD dwCb = 0;
    DWORD dwRet = ERROR_SUCCESS;
    DWORD dwConnections = 0;
    LPRASCONN lpRasConn = NULL;
    
    // Call RasEnumConnections with lpRasConn = NULL. dwCb is returned with the required buffer size and 
    // a return code of ERROR_BUFFER_TOO_SMALL
    dwRet = RasEnumConnections(lpRasConn, &dwCb, &dwConnections);

    if (dwRet == ERROR_BUFFER_TOO_SMALL){
        // Allocate the memory needed for the array of RAS structure(s).
        lpRasConn = (LPRASCONN) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dwCb);
        if (lpRasConn == NULL){
            wprintf(L"HeapAlloc failed!\n");
            return 0;
        }
        // The first RASCONN structure in the array must contain the RASCONN structure size
        lpRasConn[0].dwSize = sizeof(RASCONN);
        
        // Call RasEnumConnections to enumerate active connections
        dwRet = RasEnumConnections(lpRasConn, &dwCb, &dwConnections);

        // If successful, print the names of the active connections.
        if (ERROR_SUCCESS == dwRet){
            wprintf(L"The following RAS connections are currently active:\n");
            for (DWORD i = 0; i < dwConnections; i++){
                         wprintf(L"%s\n", lpRasConn[i].szEntryName);
                  }
        }
        //Deallocate memory for the connection buffer
        HeapFree(GetProcessHeap(), 0, lpRasConn);
        lpRasConn = NULL;
        return 0;
    }

    // There was either a problem with RAS or there are no connections to enumerate    
    if(dwConnections >= 1){
        wprintf(L"The operation failed to acquire the buffer size.\n");
    }else{
        wprintf(L"There are no active RAS connections.\n");
    }

    return 0;
}

RasEnumConnections ne peut pas énumérer une connexion en tant que active jusqu’à ce que RAS soit correctement connecté.

Windows Me/98/95 : RasEnumConnections énumère une connexion comme active dès qu’elle commence à composer.

La façon la plus fiable d’énumérer et de vérifier une connexion active consiste à appeler RasEnumConnections ou RasDial pour obtenir un handle de connexion, puis appeler RasGetConnectStatus pour déterminer l’état de connexion réel.

Note

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

Voir aussi

RASCONN

RasEnumEntries

RasGetConnectStatus

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

fonctions de service d’accès à distance