GetEnvironmentVariable, fonction (winbase.h)

  • Article

Récupère le contenu de la variable spécifiée à partir du bloc d’environnement du processus appelant.

Syntaxe

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  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. 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 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.

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.

Configuration requise

Condition requise Valeur
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 winbase.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

Voir aussi

Variables d’environnement

GetEnvironmentStrings

SetEnvironmentVariable