RegSetValueA-Funktion (winreg.h)

Artikel
11/20/2024

Legt die Daten für den Standard- oder unbenannten Wert eines angegebenen Registrierungsschlüssels fest. Die Daten müssen eine Textzeichenfolge sein.

Hinweis Diese Funktion wird nur zur Kompatibilität mit 16-Bit-Versionen von Windows bereitgestellt. Anwendungen sollten die RegSetValueEx--Funktion verwenden.

Syntax

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR 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 eines Unterschlüssels des hKey--Parameters. Die Funktion legt den Standardwert des angegebenen Unterschlüssels fest. Wenn lpSubKey nicht vorhanden ist, erstellt die Funktion sie.

Bei Schlüsselnamen wird die Groß-/Kleinschreibung nicht beachtet.

Wenn dieser Parameter NULL- ist oder auf eine leere Zeichenfolge verweist, legt die Funktion den Standardwert des durch hKeyidentifizierten Schlüssels fest.

Weitere Informationen finden Sie unter Registrierungselementgrößenbeschränkungen.

[in] dwType

Der Typ der zu speichernden Informationen. Dieser Parameter muss der REG_SZ Typ sein. Verwenden Sie zum Speichern anderer Datentypen die RegSetValueEx--Funktion.

[in] lpData

Die zu speichernden Daten. Dieser Parameter kann nicht NULL-werden.

[in] cbData

Dieser Parameter wird ignoriert. Die Funktion berechnet diesen Wert basierend auf der Größe der Daten im lpData Parameter.

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

Wenn der durch den parameter lpSubKey angegebene Schlüssel nicht vorhanden ist, wird er von der RegSetValue-Funktion erstellt.

Wenn die ANSI-Version dieser Funktion verwendet wird (entweder durch explizites Aufrufen RegSetValueA oder durch nicht definieren unicode vor dem Einschließen der Datei "Windows.h"), muss der lpData Parameter eine ANSI-Zeichenzeichenfolge sein. Die Zeichenfolge wird in Unicode konvertiert, bevor sie in der Registrierung gespeichert wird.

Anmerkung

Der winreg.h-Header definiert RegSetValue 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 [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winreg.h (enthalten Windows.h)
Library	Advapi32.lib
DLL-	Advapi32.dll