SHRegGetPathA-Funktion (shlwapi.h)

Artikel
08/26/2023

Ruft einen Dateipfad aus der Registrierung ab und erweitert nach Bedarf Umgebungsvariablen.

Syntax

LSTATUS SHRegGetPathA(
  [in]  HKEY   hKey,
  [in]  LPCSTR pcszSubKey,
  [in]  LPCSTR pcszValue,
  [out] LPSTR  pszPath,
        DWORD  dwFlags
);

Parameter

[in] hKey

Typ: HKEY

Ein Handle für einen derzeit geöffneten Schlüssel oder einen Registrierungsstammschlüssel.

[in] pcszSubKey

Typ: LPCTSTR

Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Namen des Unterschlüssels enthält.

[in] pcszValue

Typ: LPCTSTR

Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Namen des Werts enthält, der die nicht erweiterten Pfadzeichenfolge enthält.

[out] pszPath

Typ: LPTSTR

Ein Puffer, der den erweiterten Pfad enthält. Sie sollten die Größe dieses Puffers auf MAX_PATH festlegen, um sicherzustellen, dass er groß genug ist, um die zurückgegebene Zeichenfolge zu enthalten.

dwFlags

Art: DWORD

Reserviert.

Rückgabewert

Typ: LSTATUS

Gibt bei erfolgreicher Ausführung ERROR_SUCCESS oder andernfalls einen Windows-Fehlercode zurück.

Hinweise

Der Datentyp des angegebenen Registrierungswerts muss entweder REG_EXPAND_SZ oder REG_SZ sein. Wenn es den typ REG_EXPAND_SZ hat, werden alle Umgebungsvariablen in der Registrierungszeichenfolge mit ExpandEnvironmentStrings erweitert. Wenn es den Datentyp REG_SZ hat, werden Umgebungsvariablen nicht erweitert, und die Zeichenfolge, auf die von pszPath verwiesen wird, ist mit der Zeichenfolge in der Registrierung identisch.

Die folgenden Umgebungszeichenfolgen werden durch den entsprechenden Pfad ersetzt.

Umgebungszeichenfolge	Ordner
%USERPROFILE%	Der Profilordner des aktuellen Benutzers
%ALLUSERSPROFILE%	Der Profilordner "Alle Benutzer"
%ProgramFiles%	Ordner "Programme"
%SystemRoot%	Der Systemstammordner
%SystemDrive%	Der Systemlaufwerkbuchstabe

Hinweis : %USERPROFILE% ist relativ zum Benutzer, der den Anruf vornimmt. Diese Funktion funktioniert nicht, wenn der Benutzer von einem Dienst aus identitätswechselt wird.

Hinweis

Der shlwapi.h-Header definiert SHRegGetPath 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, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shlwapi.h
Bibliothek	Shlwapi.lib
DLL	Shlwapi.dll (Version 5.0 oder höher)

Share via