SHDeleteKeyA-Funktion (shlwapi.h)

Artikel
11/20/2024

Löscht einen Unterschlüssel und alle untergeordneten Elemente. Mit dieser Funktion werden der Schlüssel und alle Werte des Schlüssels aus der Registrierung entfernt.

Syntax

LSTATUS SHDeleteKeyA(
  [in]           HKEY   hkey,
  [in, optional] LPCSTR pszSubKey
);

Parameter

[in] hkey

Typ: HKEY-

Ein Handle für einen geöffneten Registrierungsschlüssel oder einen der folgenden vordefinierten Schlüssel:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Typ: LPCTSTR-

Die Adresse einer mit Null beendeten Zeichenfolge, die den Namen des zu löschenden Schlüssels angibt.

Rückgabewert

Typ: LSTATUS-

Gibt ERROR_SUCCESS zurück, wenn dies erfolgreich ist, oder wenn der Fehlercode nicht 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 abzurufen.

Bemerkungen

Alternativ können Sie die RegDeleteKey- oder RegDeleteTree--Funktion verwenden.

Anmerkung

Der Header "shlwapi.h" definiert SHDeleteKey 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, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlwapi.h
Library	Shlwapi.lib
DLL-	Shlwapi.dll (Version 4.71 oder höher)

Freigeben über