RegSetKeyValueA-Funktion (winreg.h)
Legt die Daten für den angegebenen Wert im angegebenen Registrierungsschlüssel und Unterschlüssel fest.
Syntax
LSTATUS RegSetKeyValueA(
[in] HKEY hKey,
[in, optional] LPCSTR lpSubKey,
[in, optional] LPCSTR lpValueName,
[in] DWORD dwType,
[in, optional] LPCVOID lpData,
[in] DWORD cbData
);
Parameter
[in] hKey
Ein Handle zu einem geöffneten Registrierungsschlüssel. Der Schlüssel muss mit dem KEY_SET_VALUE Zugriffsrecht geöffnet worden sein. Weitere Informationen finden Sie unter Registry Key Security and Access Rights.
Dieses Handle wird von der RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyExoder RegOpenKeyTransacted Funktion zurückgegeben. Es kann auch einer der folgenden vordefinierten Schlüsselsein:
HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
[in, optional] lpSubKey
Der Name des Unterschlüssels relativ zum durch hKeyidentifizierten Schlüssel. Wenn der Unterschlüssel nicht vorhanden ist, wird er als nicht veränderliche Schlüssel mit einem Standardsicherheitsdeskriptor erstellt. Wenn dieser Parameter NULL-ist, wird der Wert in dem durch hKeyangegebenen Schlüssel erstellt.
[in, optional] lpValueName
Der Name des Registrierungswerts, dessen Daten aktualisiert werden sollen.
[in] dwType
Der Datentyp, auf den der lpData--Parameter verweist. Eine Liste der möglichen Typen finden Sie unter Registrierungswerttypen.
[in, optional] lpData
Die Daten, die mit dem angegebenen Wertnamen gespeichert werden sollen.
Bei zeichenfolgenbasierten Typen, z. B. REG_SZ, muss die Zeichenfolge null-terminated sein. Mit dem Datentyp REG_MULTI_SZ muss die Zeichenfolge mit zwei Nullzeichen beendet werden.
[in] cbData
Die Größe der Informationen, auf die durch den parameter lpData in Bytes verwiesen wird. Wenn die Daten vom Typ REG_SZ, REG_EXPAND_SZ oder REG_MULTI_SZ sind, muss cbData- die Größe des endierenden NULL-Zeichens oder Zeichen enthalten.
Rückgabewert
Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.
Wenn die Funktion fehlschlägt, ist der Rückgabewert 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 allgemeine Beschreibung des Fehlers zu erhalten.
Bemerkungen
Um eine Anwendung zu kompilieren, die diese Funktion verwendet, definieren Sie _WIN32_WINNT als 0x0600 oder höher. Weitere Informationen finden Sie unter Verwenden der Windows-Header.
Anmerkung
Der winreg.h-Header definiert RegSetKeyValue 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 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 Vista [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows Server 2008 [Nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | winreg.h (enthalten Windows.h) |
| Library | Advapi32.lib |
| DLL- | Advapi32.dll |