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 für einen 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 Sicherheit und Zugriffsrechte für Registrierungsschlüssel.
Dieses Handle wird von der RegCreateKeyEx-, RegCreateKeyTransacted-, RegOpenKeyEx- oder RegOpenKeyTransacted-Funktion zurückgegeben, oder es kann sich um einen der folgenden vordefinierten Schlüssel handelt:
- 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 in Winerror.h definierter Fehlercode ungleich null. Sie können die FormatMessage-Funktion mit dem flag FORMAT_MESSAGE_FROM_SYSTEM verwenden, um eine generische Beschreibung des Fehlers abzurufen.
Hinweise
Wenn der Schlüssel Werte aufweist, muss er mit KEY_SET_VALUE geöffnet werden, andernfalls schlägt diese Funktion 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.
Hinweis
In Legacyversionen von Windows wird diese API auch von kernel32.dll verfügbar gemacht.
Hinweis
Der winreg.h-Header definiert RegDeleteTree 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 |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | winreg.h (Windows.h einschließen) |
| Bibliothek | Advapi32.lib |
| DLL | Advapi32.dll |