RegDeleteTreeA-Funktion (winreg.h)

Löscht die Unterschlüssel und Werte des angegebenen Schlüssels rekursiv.

Syntax

LSTATUS RegDeleteTreeA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey
);

Parameter

[in] hKey

Ein Handle zu einem geöffneten Registrierungsschlüssel. Der Schlüssel muss mit den folgenden Zugriffsrechten geöffnet worden sein: DELETE, KEY_ENUMERATE_SUB_KEYS und KEY_QUERY_VALUE. Weitere Informationen finden Sie unter Registry Key Security and Access Rights.

Dieser Handle wird von der RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyExoder RegOpenKeyTransacted Funktion zurückgegeben, oder es kann sich um eine der folgenden Vordefinierte Schlüsselsein:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

Der Name des Schlüssels. Dieser Schlüssel muss ein Unterschlüssel des schlüssels sein, der durch den hKey Parameter identifiziert wird. Wenn dieser Parameter NULL-ist, werden die Unterschlüssel und Werte von hKey- gelöscht.

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 Schlüssel Werte enthält, muss er mit KEY_SET_VALUE geöffnet werden, oder diese Funktion schlägt mit ERROR_ACCESS_DENIED fehl.

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.

Anforderungen

Siehe auch

RegDeleteKey-

RegDeleteKeyEx-

RegDeleteKeyTransacted

Registrierungsfunktionen