GetEnvironmentVariableW, fonction (processenv.h)
Récupère le contenu de la variable spécifiée à partir du bloc d’environnement du processus appelant.
Syntaxe
DWORD GetEnvironmentVariableW(
[in, optional] LPCWSTR lpName,
[out, optional] LPWSTR 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 sous la forme d’une chaîne terminée par null.
La taille maximale d’une variable d’environnement définie par l’utilisateur est de 32 767 caractères. Il n’existe aucune limitation technique sur la taille du bloc d’environnement. Toutefois, il existe des limites pratiques en fonction du mécanisme utilisé pour accéder au bloc. Par exemple, un fichier de commandes ne peut pas définir une variable supérieure à la longueur maximale de la ligne de commande. Pour plus d’informations, consultez Variables d’environnement.
[in] nSize
Taille de la mémoire tampon pointée vers par le paramètre lpBuffer , y compris le caractère de fin null, en caractères.
Valeur retournée
Si la fonction réussit, la valeur de retour correspond au 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 assez grand 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 n’est pas défini.
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.
Notes
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.
Notes
L’en-tête processenv.h définit GetEnvironmentVariable en tant qu’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. La combinaison 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.
Spécifications
| Client minimal pris en charge | Windows XP [applications de bureau | applications UWP] |
| Serveur minimal pris en charge | Windows Server 2003 [applications de bureau | applications UWP] |
| Plateforme cible | Windows |
| 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 |