GetEnvironmentVariableA-Funktion (processenv.h)

  • Artikel

Ruft den Inhalt der angegebenen Variablen aus dem Umgebungsblock des aufrufenden Prozesses ab.

Syntax

DWORD GetEnvironmentVariableA(
  [in, optional]  LPCSTR lpName,
  [out, optional] LPSTR  lpBuffer,
  [in]            DWORD  nSize
);

Parameter

[in, optional] lpName

Der Name der Umgebungsvariablen.

[out, optional] lpBuffer

Ein Zeiger auf einen Puffer, der den Inhalt der angegebenen Umgebungsvariablen als null-endende Zeichenfolge empfängt. Eine Umgebungsvariable hat eine maximale Größenbeschränkung von 32.767 Zeichen, einschließlich des NULL-Endzeichens.

[in] nSize

Die Größe des Puffers, auf den der lpBuffer-Parameter verweist, einschließlich des NULL-Endzeichens, in Zeichen.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der Zeichen, die im Puffer gespeichert sind, auf den lpBuffer verweist, ohne das abschließende NULL-Zeichen.

Wenn lpBuffer nicht groß genug ist, um die Daten zu speichern, ist der Rückgabewert die Puffergröße in Zeichen, die erforderlich ist, um die Zeichenfolge zu speichern, und ihr abschließendes NULL-Zeichen und der Inhalt von lpBuffer sind undefiniert.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Wenn die angegebene Umgebungsvariable nicht im Umgebungsblock gefunden wurde, gibt GetLastError ERROR_ENVVAR_NOT_FOUND zurück.

Hinweise

Diese Funktion kann entweder eine Systemumgebungsvariable oder eine Benutzerumgebungsvariable abrufen.

Beispiele

Ein Beispiel finden Sie unter Ändern von Umgebungsvariablen.

Hinweis

Der processenv.h-Header definiert GetEnvironmentVariable als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows XP [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile processenv.h (enthalten Windows.h unter Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Umgebungsvariablen

GetEnvironmentStrings

Setenvironmentvariable