SHRegSetPathW-Funktion (shlwapi.h)

Verwendet einen Dateipfad, ersetzt Ordnernamen durch Umgebungszeichenfolgen und platziert die resultierende Zeichenfolge in der Registrierung.

Syntax

LSTATUS SHRegSetPathW(
  [in] HKEY    hKey,
  [in] LPCWSTR pcszSubKey,
  [in] LPCWSTR pcszValue,
  [in] LPCWSTR pcszPath,
       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 eines vorhandenen Unterschlüssels enthält. Wenn der Unterschlüssel nicht vorhanden ist, schlägt SHRegSetPath- fehl.

[in] pcszValue

Typ: LPCTSTR-

Ein Zeiger auf eine mit Null beendete Zeichenfolge mit dem Namen des Werts, der die Pfadzeichenfolge enthält.

[in] pcszPath

Typ: LPCTSTR-

Ein Zeiger auf eine mit Null beendete Zeichenfolge mit einem vollqualifizierten Dateipfad.

dwFlags

Typ: DWORD-

Reserviert.

Rückgabewert

Typ: LSTATUS-

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

Bemerkungen

Für Windows 2000 verwendet SHRegSetPathPathUnExpandEnvStrings, um Ordnernamen in ihre entsprechende Umgebungszeichenfolge zu konvertieren. Wenn Umgebungsvariablen ersetzt wurden, wird der Registrierungswert mit dem datentyp REG_EXPAND_SZ festgelegt. Andernfalls wird sie mit dem datentyp REG_SZ festgelegt.

Die folgenden Ordnerpfade werden durch die entsprechende Umgebungszeichenfolge ersetzt.

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

 

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

 

Die in der obigen Tabelle aufgeführten Umgebungsvariablen werden möglicherweise nicht alle auf einem bestimmten System festgelegt. Wenn keine Umgebungsvariable festgelegt ist, wird sie nicht erweitert. Insbesondere werden keine dieser Variablen für die Standardumgebung von Windows 95 oder Windows 98 festgelegt. Die %ProgramFiles% Variable ist neu für Windows 2000 und wird in der Regel nicht auf Microsoft Windows NT 4.0-Systemen festgelegt.

Anmerkung

Der Header "shlwapi.h" definiert SHRegSetPath 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)