GetEnvironmentVariableA, fonction (processenv.h)
Récupère le contenu de la variable spécifiée à partir du bloc d’environnement du processus appelant.
Syntaxe
DWORD GetEnvironmentVariableA(
[in, optional] LPCSTR lpName,
[out, optional] LPSTR lpBuffer,
[in] DWORD nSize
);
Paramètres
[in, optional] lpName
Nom de la variable d’environnement.
[out, optional] lpBuffer
Pointeur vers une mémoire tampon qui reçoit le contenu de la variable d’environnement spécifiée en tant que chaîne terminée par null. Une variable d’environnement a une limite de taille maximale de 32 767 caractères, y compris le caractère de fin null.
[in] nSize
Taille de la mémoire tampon pointée par le paramètre lpBuffer, y compris le caractère de fin null, en caractères.
Valeur de retour
Si la fonction réussit, la valeur de retour est le nombre de caractères stockés dans la mémoire tampon pointée par lpBuffer, sans inclure le caractère null de fin.
Si lpBuffer n’est pas suffisamment volumineux pour contenir les données, la valeur de retour est la taille de la mémoire tampon, en caractères, nécessaire pour contenir la chaîne et son caractère null de fin et le contenu de lpBuffer ne sont pas définis.
Si la fonction échoue, la valeur de retour est égale à zéro. Si la variable d’environnement spécifiée est introuvable dans le bloc d’environnement, GetLastError retourne ERROR_ENVVAR_NOT_FOUND.
Remarques
Cette fonction peut récupérer une variable d’environnement système ou une variable d’environnement utilisateur.
Exemples
Pour obtenir un exemple, consultez modification des variables d’environnement.
Note
L’en-tête processenv.h définit GetEnvironmentVariable 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 XP [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2003 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | processenv.h (inclure Windows.h sur Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |