RasEnumDevicesA, fonction (ras.h)

Article
11/20/2024

La fonction RasEnumDevices retourne le nom et le type de tous les appareils compatibles RAS disponibles.

Syntaxe

DWORD RasEnumDevicesA(
  [in]      LPRASDEVINFOA unnamedParam1,
  [in, out] LPDWORD       unnamedParam2,
  [out]     LPDWORD       unnamedParam3
);

Paramètres

[in] unnamedParam1

Pointeur vers une mémoire tampon qui reçoit un tableau de structures RASDEVINFO, une pour chaque appareil compatible RAS. Avant d’appeler la fonction, définissez le dwSize membre du premier structure RASDEVINFO dans la mémoire tampon sur sizeof(RASDEVINFO) pour identifier la version de la structure.

[in, out] unnamedParam2

Pointeur vers une variable qui, en entrée, contient la taille, en octets, de la mémoire tampon lpRasDevInfo tampon.

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

note

Pour déterminer la taille de mémoire tampon requise, appelez RasEnumDevices avec lpRasDevInfo 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 RASDEVINFO écrites dans la mémoire tampon lpRasDevInfo.

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_BUFFER_TOO_SMALL	La mémoire tampon lpRasDevInfo n’est pas suffisamment grande. Le paramètre lpcb est inférieur au membre dwSize dans le paramètre lpRasDevInfo 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.
ERROR_NOT_ENOUGH_MEMORY	Indique une mémoire insuffisante. Le paramètre lpRasDevInfo n’est pasNULL, le paramètre lpcb n’est pas NULL et une allocation de mémoire interne a échoué. Cela est peut-être dû à une condition de mémoire faible.
ERROR_INVALID_PARAMETER	Indique une valeur de paramètre non valide. Le paramètre lpcb est NULL ou le paramètre lpcDevices est NULL.
ERROR_INVALID_USER_BUFFER	L’adresse ou la mémoire tampon spécifiée par lpRasDevInfo n’est pas valide. Le paramètre dwSize du paramètre lpRasDevInfo n’est pas égal à sizeof(RASDEVINFO).

Remarques

L’exemple de code suivant énumère les appareils sur l’ordinateur actuel. Le code appelle initialement RasEnumDevices avec un paramètre lpRasDevInfo de NULL, pour obtenir la taille de la mémoire tampon à transmettre. Le code définit également le membre dwSize du premier RASDEVINFO structure sur sizeof(RASDEVINFO) pour spécifier la version de la structure.

#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 dwDevices = 0;
    LPRASDEVINFO lpRasDevInfo = NULL;
    
    // Call RasEnumDevices with lpRasDevInfo = NULL. dwCb is returned with the required buffer size and 
    // a return code of ERROR_BUFFER_TOO_SMALL
    dwRet = RasEnumDevices(lpRasDevInfo, &dwCb, &dwDevices);

    if (dwRet == ERROR_BUFFER_TOO_SMALL){
        // Allocate the memory needed for the array of RAS structure(s).
        lpRasDevInfo = (LPRASDEVINFO) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, dwCb);
        if (lpRasDevInfo == NULL){
            wprintf(L"HeapAlloc failed!\n");
            return 0;
        }
        // The first RASDEVINFO structure in the array must contain the structure size
        lpRasDevInfo[0].dwSize = sizeof(RASDEVINFO);
        
        // Call RasEnumDevices to enumerate RAS devices
        dwRet = RasEnumDevices(lpRasDevInfo, &dwCb, &dwDevices);

        // If successful, print the names of the RAS devices
        if (ERROR_SUCCESS == dwRet){
            wprintf(L"The following RAS devices were found:\n");
            for (DWORD i = 0; i < dwDevices; i++){
                         wprintf(L"%s\n", lpRasDevInfo[i].szDeviceName);
                  }
        }
        //Deallocate memory for the connection buffer
        HeapFree(GetProcessHeap(), 0, lpRasDevInfo);
        lpRasDevInfo = NULL;
        return 0;
    }

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

    return 0;
}

Note

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

Voir aussi

RASDEVINFO

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

fonctions de service d’accès à distance

Partager via