Funzione GetEnvironmentVariableA (processenv.h)

Articolo
11/20/2024

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 32.767 caratteri, incluso il carattere di terminazione Null.

[in] nSize

Dimensioni 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, necessario 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.

Osservazioni

Questa funzione può recuperare una variabile di ambiente di sistema o una variabile di ambiente utente.

Esempi

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 del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows XP [app desktop \| App UWP]
server minimo supportato	Windows Server 2003 [app desktop \| App UWP]
piattaforma di destinazione	Finestre
intestazione	processenv.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

Condividi tramite