Fonction SHDeleteKeyA (shlwapi.h)

Article
08/26/2023

Supprime une sous-clé et tous ses descendants. Cette fonction supprime la clé et toutes les valeurs de la clé du Registre.

Syntaxe

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

Paramètres

[in] hkey

Type : HKEY

Handle vers une clé de Registre ouverte ou l’une des clés prédéfinies suivantes :

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Type : LPCTSTR

Adresse d’une chaîne terminée par null spécifiant le nom de la clé à supprimer.

Valeur retournée

Type : LSTATUS

Retourne ERROR_SUCCESS en cas de réussite, ou un code d’erreur différent de zéro défini dans Winerror.h dans le cas contraire. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM pour récupérer une description générique de l’erreur.

Remarques

Vous pouvez également utiliser la fonction RegDeleteKey ou RegDeleteTree .

Notes

L’en-tête shlwapi.h définit SHDeleteKey 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, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shlwapi.h
Bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 ou ultérieure)

Partager via