SHRegSetPathA-Funktion (shlwapi.h)

  • Artikel

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

Syntax

LSTATUS SHRegSetPathA(
  [in] HKEY   hKey,
  [in] LPCSTR pcszSubKey,
  [in] LPCSTR pcszValue,
  [in] LPCSTR pcszPath,
       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-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 NULL-Zeichenfolge mit dem Namen des Werts, der die Pfadzeichenfolge enthält.

[in] pcszPath

Typ: LPCTSTR

Ein Zeiger auf eine NULL-Zeichenfolge mit einem vollqualifizierten Dateipfad.

dwFlags

Art: DWORD

Reserviert.

Rückgabewert

Typ: LSTATUS

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

Hinweise

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

Die folgenden Ordnerpfade werden durch ihre entsprechende Umgebungszeichenfolge ersetzt.

Ordner Umgebungszeichenfolge
Der Profilordner des aktuellen Benutzers %USERPROFILE%
Der Profilordner "Alle Benutzer" %ALLUSERSPROFILE%
Ordner "Programme" %ProgramFiles%
Der Systemstammordner %SystemRoot%
Der Systemlaufwerkbuchstabe %SystemDrive%
 
Hinweis :%USERPROFILE% ist relativ zum Benutzer, der den Anruf abnimmt. Diese Funktion funktioniert nicht, wenn der Benutzer von einem Dienst identitätswechselt wird.
 
Die in der obigen Tabelle aufgeführten Umgebungsvariablen werden möglicherweise nicht alle auf einem bestimmten System festgelegt. Wenn eine Umgebungsvariable nicht festgelegt ist, ist sie nicht unerweitert. Insbesondere ist keine dieser Variablen für die Standardumgebung von Windows 95 oder Windows 98 festgelegt. Die Variable %ProgramFiles% ist neu für Windows 2000 und wird in der Regel nicht auf Microsoft Windows NT 4.0-Systemen festgelegt.

Hinweis

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