ExpandEnvironmentStringsA-Funktion (processenv.h)

  • Artikel

Erweitert umgebungsvariable Zeichenfolgen und ersetzt sie durch die werte, die für den aktuellen Benutzer definiert sind.

Verwenden Sie die Funktion ExpandEnvironmentStringsForUser, um den Umgebungsblock für einen bestimmten Benutzer oder das System anzugeben.

Syntax

DWORD ExpandEnvironmentStringsA(
  [in]            LPCSTR lpSrc,
  [out, optional] LPSTR  lpDst,
  [in]            DWORD  nSize
);

Parameter

[in] lpSrc

Ein Puffer, der eine oder mehrere Umgebungsvariablenzeichenfolgen in der Form enthält: %variableName%. Für jeden solchen Verweis wird der %variableName%-Teil durch den aktuellen Wert dieser Umgebungsvariablen ersetzt.

Die Groß-/Kleinschreibung wird ignoriert, wenn sie den Namen der Umgebungsvariablen sucht. Wenn der Name nicht gefunden wird, wird der %variableName%-Teil nicht erweitert.

Beachten Sie, dass diese Funktion nicht alle Features unterstützt, die Cmd.exe unterstützt. Beispielsweise wird %variableName:str1=str2% oder %variableName:~offset,length% nicht unterstützt.

[out, optional] lpDst

Ein Zeiger auf einen Puffer, der das Ergebnis der Erweiterung der Umgebungsvariablenzeichenfolgen im lpSrc-Puffer empfängt. Beachten Sie, dass dieser Puffer nicht mit dem lpSrc-Puffer identisch sein kann.

[in] nSize

Die maximale Anzahl von Zeichen, die im Puffer gespeichert werden können, auf den der lpDst-Parameter verweist. Bei Verwendung von ANSI-Zeichenfolgen sollte die Puffergröße die Zeichenfolgenlänge plus null-Endzeichen plus eins sein. Bei Verwendung von Unicode-Zeichenfolgen sollte die Puffergröße die Zeichenfolgenlänge plus das abschließende NULL-Zeichen sein.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der im Zielpuffer gespeicherten TCHARs , einschließlich des abschließenden NULL-Zeichens. Wenn der Zielpuffer zu klein ist, um die erweiterte Zeichenfolge zu enthalten, ist der Rückgabewert die erforderliche Puffergröße in Zeichen.

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

Hinweise

Die Größe der Puffer lpSrc und lpDst ist auf 32K beschränkt.

Verwenden Sie die PathUnExpandEnvStrings-Funktion , um Ordnernamen in einem vollqualifizierten Pfad durch die zugeordneten Umgebungsvariablenzeichenfolgen zu ersetzen.

Verwenden Sie die GetEnvironmentStrings-Funktion, um die Liste der Umgebungsvariablen für einen Prozess abzurufen.

Beispiele

Ein Beispiel finden Sie unter Abrufen von Systeminformationen.

Hinweis

Der processenv.h-Header definiert ExpandEnvironmentStrings 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

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile processenv.h (windows.h einschließen)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Umgebungsvariablen

Systeminformationsfunktionen