SetEnvironmentVariableA-Funktion (processenv.h)
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 Umgebungsvariable. Das Betriebssystem erstellt die Umgebungsvariable, wenn sie nicht vorhanden ist, und lpValue- ist nicht NULL.
[in, optional] lpValue
Der Inhalt der Umgebungsvariable. 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 fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Diese Funktion hat keine Auswirkungen auf die Systemumgebungsvariablen oder die Umgebungsvariablen anderer Prozesse.
Beispiele
Ein Beispiel finden Sie unter Ändern von Umgebungsvariablen.
Anmerkung
Der processenv.h-Header definiert SetEnvironmentVariable als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows XP [Desktop-Apps | UWP-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Desktop-Apps | UWP-Apps] |
| Zielplattform- | Fenster |
| Header- | processenv.h (include Windows.h on Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| Library | Kernel32.lib |
| DLL- | Kernel32.dll |