RegUnLoadKeyA, fonction (winreg.h)

Article
11/20/2024

Décharge la clé de Registre spécifiée et ses sous-clés à partir du Registre.

Les applications qui sauvegardent ou restaurent l’état du système, y compris les fichiers système et les ruches de Registre, doivent utiliser le service de cliché instantané de volume au lieu des fonctions de Registre.

Syntaxe

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

Paramètres

[in] hKey

Handle vers la clé de Registre à décharger. Ce paramètre peut être un handle retourné par un appel à Fonction RegConnectRegistry ou l’un des handles prédéfinis suivants :

HKEY_LOCAL_MACHINEHKEY_USERS

[in, optional] lpSubKey

Nom de la sous-clé à décharger. La clé référencée par le paramètre lpSubKey doit avoir été créée à l’aide de la fonction RegLoadKey.

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

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

Valeur de retour

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. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur de FORMAT_MESSAGE_FROM_SYSTEM pour obtenir une description générique de l’erreur.

Remarques

Cette fonction supprime une ruche du Registre, mais ne modifie pas le fichier contenant les informations du Registre. Une ruche est un corps discret de clés, de sous-clés et de valeurs enracinées en haut de la hiérarchie du Registre.

Le processus appelant doit disposer des privilèges SE_RESTORE_NAME et SE_BACKUP_NAME sur l’ordinateur dans lequel réside le Registre. Pour plus d’informations, consultez Exécution avec des privilèges spéciaux.

Note

L’en-tête winreg.h définit RegUnLoadKey comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winreg.h (inclure Windows.h)
bibliothèque	Advapi32.lib
DLL	Advapi32.dll