SHRegGetPathA-Funktion (shlwapi.h)

Artikel
11/20/2024

Ruft einen Dateipfad aus der Registrierung ab, um Umgebungsvariablen nach Bedarf zu erweitern.

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 aktuell geöffneten Schlüssel oder einen Registrierungsstammschlüssel.

[in] pcszSubKey

Typ: LPCTSTR-

Ein Zeiger auf eine mit Null beendete Zeichenfolge, die den Namen des Unterschlüssels enthält.

[in] pcszValue

Typ: LPCTSTR-

Ein Zeiger auf eine mit Null beendete 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 enthalten soll. Sie sollten die Größe dieses Puffers auf MAX_PATH festlegen, um sicherzustellen, dass die zurückgegebene Zeichenfolge groß genug ist.

dwFlags

Typ: DWORD-

Reserviert.

Rückgabewert

Typ: LSTATUS-

Gibt ERROR_SUCCESS zurück, wenn dies erfolgreich ist, oder ein Windows-Fehlercode andernfalls.

Bemerkungen

Der Datentyp des angegebenen Registrierungswerts muss entweder REG_EXPAND_SZ oder REG_SZsein. Wenn sie den REG_EXPAND_SZ Typ aufweist, werden alle Umgebungsvariablen in der Registrierungszeichenfolge mit ExpandEnvironmentStringserweitert. Wenn der Datentyp REG_SZ aufweist, werden Umgebungsvariablen nicht erweitert, und die Zeichenfolge, auf die pszPath verweist, ist mit der Zeichenfolge in der Registrierung identisch.

Die folgenden Umgebungszeichenfolgen werden durch ihren entsprechenden Pfad ersetzt.

Umgebungszeichenfolge	Ordner
%USERPROFILE%	Der Profilordner des aktuellen Benutzers
%ALLUSERSPROFILE%	Der Ordner "Alle Benutzer"-Profil
%ProgramFiles%	Der Ordner "Programme"
%SystemRoot%	Der Systemstammordner
%SystemDrive%	Der Laufwerkbuchstaben des Systems

Hinweis %USERPROFILE% relativ zum Benutzer, der den Anruf vornimmt. Diese Funktion funktioniert nicht, wenn der Benutzer von einem Dienst imitiert wird.

Anmerkung

Der Header "shlwapi.h" 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
mindestens unterstützte Client-	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 5.0 oder höher)

Freigeben über