Funzione GetEnvironmentVariableA (processenv.h)
Recupera il contenuto della variabile specificata dal blocco di ambiente del processo chiamante.
Sintassi
DWORD GetEnvironmentVariableA(
[in, optional] LPCSTR lpName,
[out, optional] LPSTR lpBuffer,
[in] DWORD nSize
);
Parametri
[in, optional] lpName
Nome della variabile di ambiente.
[out, optional] lpBuffer
Puntatore a un buffer che riceve il contenuto della variabile di ambiente specificata come stringa con terminazione null. Una variabile di ambiente ha un limite massimo di dimensioni pari a 32.767 caratteri, incluso il carattere null-terminazione.
[in] nSize
Dimensioni del buffer a cui punta il parametro lpBuffer , incluso il carattere null-terminazione, in caratteri.
Valore restituito
Se la funzione ha esito positivo, il valore restituito è il numero di caratteri archiviati nel buffer a cui punta lpBuffer, non incluso il carattere Null terminante.
Se lpBuffer non è abbastanza grande per contenere i dati, il valore restituito è la dimensione del buffer, in caratteri, necessari per contenere la stringa e il relativo carattere Null terminante e il contenuto di lpBuffer non sono definiti.
Se la funzione ha esito negativo, il valore restituito è zero. Se la variabile di ambiente specificata non è stata trovata nel blocco di ambiente, GetLastError restituisce ERROR_ENVVAR_NOT_FOUND.
Commenti
Questa funzione può recuperare una variabile di ambiente di sistema o una variabile di ambiente utente.
Esempio
Per un esempio, vedere Modifica delle variabili di ambiente.
Nota
L'intestazione processenv.h definisce GetEnvironmentVariable 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
| Client minimo supportato | Windows XP [app desktop | App UWP] |
| Server minimo supportato | Windows Server 2003 [app desktop | App UWP] |
| Piattaforma di destinazione | Windows |
| Intestazione | processenv.h (includono Windows.h in Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| Libreria | Kernel32.lib |
| DLL | Kernel32.dll |