SHSetValueA-Funktion (shlwapi.h)

Artikel
11/20/2024

Legt den Wert eines Registrierungsschlüssels fest.

Syntax

LSTATUS SHSetValueA(
  [in]           HKEY    hkey,
  [in, optional] LPCSTR  pszSubKey,
  [in, optional] LPCSTR  pszValue,
  [in]           DWORD   dwType,
  [in, optional] LPCVOID pvData,
  [in]           DWORD   cbData
);

Parameter

[in] hkey

Typ: HKEY-

Ein Handle für den aktuell geöffneten Schlüssel oder einen der folgenden vordefinierten Werte.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Typ: LPCTSTR-

Die Adresse einer mit Null beendeten Zeichenfolge, die den Namen des Unterschlüssels angibt, dem ein Wert zugeordnet ist. Dies kann NULL- oder ein Zeiger auf eine leere Zeichenfolge sein. In diesem Fall wird der Wert dem durch den hkey Parameter identifizierten Schlüssel hinzugefügt.

[in, optional] pszValue

Typ: LPCTSTR-

Die Adresse einer mit Null beendeten Zeichenfolge, die den Wert angibt. Dieser Wert kann NULL-sein.

[in] dwType

Typ: DWORD-

Typ der zu speichernden Daten. Dieser Parameter muss der REG_SZ Typ sein. Weitere Informationen finden Sie unter Registrierungsdatentypen.

[in, optional] pvData

Typ: LPCVOID-

Zeigen Sie auf einen Puffer, der die für den angegebenen Wert festzulegenden Daten enthält. Dieser Wert kann NULL-sein.

[in] cbData

Typ: DWORD-

Die Länge des Puffers in Bytes, auf den der pvData--Parameter verweist. Wenn es sich bei den Daten um eine mit Null beendete Zeichenfolge handelt, enthält diese Länge das endende Nullzeichen.

Rückgabewert

Typ: LSTATUS-

Gibt ERROR_SUCCESS zurück, wenn dies erfolgreich ist; andernfalls ein nichtzero-Fehlercode, der in Winerror.h definiert ist. Sie können die FormatMessage--Funktion mit dem FORMAT_MESSAGE_FROM_SYSTEM Flag verwenden, um eine generische Beschreibung des Fehlers abzurufen.

Bemerkungen

Anmerkung

Der Header "shlwapi.h" definiert SHSetValue 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 4.71 oder höher)

Freigeben über