Funzione GetEnvironmentVariable (winbase.h)

Recupera il contenuto della variabile specificata dal blocco di ambiente del processo chiamante.

Sintassi

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  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 32.767 caratteri, incluso il carattere di terminazione Null.

[in] nSize

Dimensione del buffer a cui punta il parametro lpBuffer , incluso il carattere di terminazione Null, in caratteri.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è il numero di caratteri archiviati nel buffer a cui punta lpBuffer, senza includere il carattere Null di terminazione.

Se lpBuffer non è sufficientemente grande da contenere i dati, il valore restituito è la dimensione del buffer, in caratteri, necessari per contenere la stringa e il relativo carattere Null di terminazione 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.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP [app desktop | App UWP]
Server minimo supportato	Windows Server 2003 [app desktop | App UWP]
Piattaforma di destinazione	Windows
Intestazione	winbase.h (include Windows.h in Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Libreria	Kernel32.lib
DLL	Kernel32.dll

Vedere anche

Variabili di ambiente

GetEnvironmentStrings

SetEnvironmentVariable