Fonction RegDeleteKeyA (winreg.h)

Article
08/27/2023

Supprime une sous-clé et ses valeurs. Notez que les noms de clés ne respectent pas la casse.

Windows 64 bits : Sur WOW64, les applications 32 bits affichent une arborescence de Registre distincte de l’arborescence du Registre que les applications 64 bits affichent. Pour permettre à une application de supprimer une entrée dans l’autre vue du Registre, utilisez la fonction RegDeleteKeyEx .

Syntaxe

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

Paramètres

[in] hKey

Handle d’une clé de Registre ouverte. Les droits d’accès de cette clé n’affectent pas l’opération de suppression. Pour plus d’informations sur les droits d’accès, consultez Sécurité de la clé de registre et droits d’accès.

Ce handle est retourné par la fonction RegCreateKeyEx ou RegOpenKeyEx , ou il peut s’agir de l’une des clés prédéfinies suivantes :

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in] lpSubKey

Nom de la clé à supprimer. Il doit s’agir d’une sous-clé de la clé que hKey identifie, mais elle ne peut pas avoir de sous-clés. Ce paramètre ne peut pas avoir la valeur NULL.

La fonction ouvre la sous-clé avec le droit d’accès DELETE.

Les noms de clés ne respectent pas la casse.

Pour plus d’informations, consultez Limites de taille des éléments du Registre.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est un code d’erreur différent de zéro défini dans Winerror.h. Pour obtenir une description générique de l’erreur, vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM.

Remarques

Une clé supprimée n’est pas supprimée tant que le dernier handle n’est pas fermé.

La sous-clé à supprimer ne doit pas avoir de sous-clés. Pour supprimer une clé et toutes ses sous-clés, vous devez énumérer les sous-clés et les supprimer individuellement. Pour supprimer des clés de manière récursive, utilisez la fonction RegDeleteTree ou SHDeleteKey .

Exemples

Pour obtenir un exemple qui utilise cette fonction, consultez Suppression d’une clé avec des sous-clés.

Notes

Sur les versions héritées de Windows, cette API est également exposée par kernel32.dll.

Notes

L’en-tête winreg.h définit RegDeleteKey comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winreg.h (inclure Windows.h)
Bibliothèque	Advapi32.lib
DLL	Advapi32.dll