Funzione RasEnumDevicesA (ras.h)
La funzione RasEnumDevices restituisce il nome e il tipo di tutti i dispositivi con supporto RAS disponibili.
Sintassi
DWORD RasEnumDevicesA(
[in] LPRASDEVINFOA unnamedParam1,
[in, out] LPDWORD unnamedParam2,
[out] LPDWORD unnamedParam3
);
Parametri
[in] unnamedParam1
Puntatore a un buffer che riceve una matrice di strutture RASDEVINFO , una per ogni dispositivo compatibile con RAS. Prima di chiamare la funzione, impostare il membro dwSize della prima struttura RASDEVINFO nel buffer su sizeof(RASDEVINFO) per identificare la versione della struttura.
[in, out] unnamedParam2
Puntatore a una variabile che, in input, contiene le dimensioni, in byte, del buffer lpRasDevInfo .
In output, la funzione imposta questa variabile sul numero di byte necessari per enumerare i dispositivi.
Per determinare le dimensioni del buffer necessarie, chiamare RasEnumDevices con lpRasDevInfo impostato su NULL. La variabile a cui punta per lpcb deve essere impostata su zero. La funzione restituirà le dimensioni del buffer necessarie in lpcb e un codice di errore di ERROR_BUFFER_TOO_SMALL.
[out] unnamedParam3
Puntatore a una variabile che riceve il numero di strutture RASDEVINFO scritte nel buffer lpRasDevInfo .
Valore restituito
Se la funzione ha esito positivo, il valore restituito è ERROR_SUCCESS.
Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti o un valore da Routing e codici di errore di accesso remoto o Winerror.h.
Valore | Significato |
---|---|
|
Il buffer lpRasDevInfo non è sufficiente. Il parametro lpcb è minore del membro dwSize nel parametro lpRasDevInfo che deve essere impostato prima di chiamare la funzione. La funzione restituisce le dimensioni del buffer necessarie nella variabile a cui punta lpcb. |
|
Indica memoria insufficiente. Il parametro lpRasDevInfo non è NULL, il parametro lpcb non è NULL e un'allocazione di memoria interna non riuscita. Questo è probabilmente dovuto a una condizione di memoria ridotta. |
|
Indica un valore di parametro non valido. Il parametro lpcb è NULL o il parametro lpcDevices è NULL. |
|
L'indirizzo o il buffer specificato da lpRasDevInfo non è valido. Il membro dwSize del parametro lpRasDevInfo non è uguale a sizeof(RASDEVINFO). |
Commenti
Il codice di esempio seguente enumera i dispositivi nel computer corrente. Il codice chiama inizialmente RasEnumDevices con un parametro lpRasDevInfonull, per ottenere le dimensioni del buffer che deve essere passato. Il codice imposta anche il membro dwSize della prima struttura RASDEVINFO su sizeof(RASDEVINFO) per specificare la versione della struttura.
#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;
}
Nota
L'intestazione ras.h definisce RasEnumDevices come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows 2000 Professional [solo app desktop] |
Server minimo supportato | Windows 2000 Server [solo app desktop] |
Piattaforma di destinazione | Windows |
Intestazione | ras.h |
Libreria | Rasapi32.lib |
DLL | Rasapi32.dll |