RegUnLoadKeyA-Funktion (winreg.h)

Artikel
08/27/2023

Entlädt den angegebenen Registrierungsschlüssel und die zugehörigen Unterschlüssel aus der Registrierung.

Anwendungen, die den Systemstatus sichern oder wiederherstellen, einschließlich Systemdateien und Registrierungsstrukturen, sollten anstelle der Registrierungsfunktionen den Volume Shadow Copy Service verwenden.

Syntax

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

Parameter

[in] hKey

Ein Handle für den zu entladenden Registrierungsschlüssel. Dieser Parameter kann ein Handle sein, das von einem Aufruf der RegConnectRegistry-Funktion oder einem der folgenden vordefinierten Handles zurückgegeben wird:

HKEY_LOCAL_MACHINEHKEY_USERS

[in, optional] lpSubKey

Der Name des zu entladenden Unterschlüssels. Der Schlüssel, auf den der parameter lpSubKey verweist, muss mithilfe der RegLoadKey-Funktion erstellt worden sein.

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

Weitere Informationen finden Sie unter Größenbeschränkungen für Registrierungselemente.

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 flag FORMAT_MESSAGE_FROM_SYSTEM verwenden, um eine generische Beschreibung des Fehlers abzurufen.

Hinweise

Diese Funktion entfernt eine Struktur aus der Registrierung, ändert jedoch nicht die Datei, die die Registrierungsinformationen enthält. Eine Struktur ist ein diskreter Text von Schlüsseln, Unterschlüsseln und Werten, der am anfang der Registrierungshierarchie verwurzelt ist.

Der aufrufende Prozess muss über die SE_RESTORE_NAME- und SE_BACKUP_NAME Berechtigungen auf dem Computer verfügen, auf dem sich die Registrierung befindet. Weitere Informationen finden Sie unter Ausführen mit speziellen Berechtigungen.

Hinweis

Der winreg.h-Header definiert RegUnLoadKey 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 nicht codierungsneutralem Code 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 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winreg.h (einschließlich Windows.h)
Bibliothek	Advapi32.lib
DLL	Advapi32.dll