SetEnvironmentVariableA-Funktion (processenv.h)

  • Artikel

Legt den Inhalt der angegebenen Umgebungsvariablen für den aktuellen Prozess fest.

Syntax

BOOL SetEnvironmentVariableA(
  [in]           LPCSTR lpName,
  [in, optional] LPCSTR lpValue
);

Parameter

[in] lpName

Der Name der Umgebungsvariablen. Das Betriebssystem erstellt die Umgebungsvariable, wenn sie nicht vorhanden ist und lpValue nicht NULL ist.

[in, optional] lpValue

Der Inhalt der Umgebungsvariablen. Die maximale Größe einer benutzerdefinierten Umgebungsvariable beträgt 32.767 Zeichen. Weitere Informationen finden Sie unter Umgebungsvariablen.

Windows Server 2003 und Windows XP: Die Gesamtgröße des Umgebungsblocks für einen Prozess darf 32.767 Zeichen nicht überschreiten.

Wenn dieser Parameter NULL ist, wird die Variable aus der Umgebung des aktuellen Prozesses gelöscht.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Diese Funktion hat keine Auswirkungen auf die Systemumgebungsvariablen oder die Umgebungsvariablen anderer Prozesse.

Beispiele

Ein Beispiel finden Sie unter Ändern von Umgebungsvariablen.

Hinweis

Der processenv.h-Header definiert SetEnvironmentVariable 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 nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung Wert
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 (einschließlich 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

Getenvironmentvariable