Partager via


FONCTION ORDeleteKey

Supprime une sous-clé et ses valeurs d’une ruche de Registre hors connexion.

Syntaxe

DWORD ORDeleteKey(
  _In_     ORHKEY Handle,
  _In_opt_ PCWSTR lpSubKey
);

Paramètres

Gérer [in]

Handle d’une clé de Registre ouverte dans une ruche de Registre hors connexion. Ce handle est retourné par la fonction ORCreateKey ou OROpenKey .

lpSubKey [in, facultatif]

Nom de la clé à supprimer. Il doit s’agir d’une sous-clé de la clé que Handle identifie, mais elle ne peut pas avoir de sous-clés.

Si la sous-clé n’existe pas, la fonction retourne ERROR_NOT_FOUND.

Si ce paramètre a la valeur NULL, la fonction supprime la clé spécifiée par le paramètre Handle . Si la clé spécifiée par le paramètre Handle est la clé racine de la ruche, la fonction retourne ERROR_INVALID_PARAMETER.

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

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. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM pour obtenir une description générique de l’erreur. Les codes d’erreur possibles sont les suivants :

  • Si la sous-clé spécifiée n’existe pas, la fonction retourne ERROR_FILE_NOT_FOUND.
  • Si la sous-clé spécifiée est la clé racine de la ruche du Registre, la fonction retourne ERROR_INVALID_PARAMETER.
  • Si la sous-clé spécifiée a des sous-clés, la fonction retourne ERROR_KEY_HAS_CHILDREN.

Notes

Si la clé de Registre spécifiée existe, elle est marquée comme supprimée. Une clé supprimée n’est pas supprimée tant que le dernier handle n’est pas fermé.

La clé à supprimer ne doit pas avoir de sous-clés. Pour supprimer une clé et toutes ses sous-clés, utilisez la fonction OREnumKey pour énumérer les sous-clés et les supprimer individuellement.

Seule la fonction ORCloseKey peut être appelée sur une clé supprimée ; toutes les autres opérations de Registre hors connexion échouent. Si la clé supprimée a été créée explicitement en appelant ORCreateKey, les ressources associées à la clé sont libérées lorsque le dernier handle de la clé supprimée est fermé.

Spécifications

Condition requise Valeur
Composant redistribuable
Bibliothèque du Registre hors connexion Windows version 1.0 ou ultérieure
En-tête
Offreg.h
DLL
Offreg.dll

Voir aussi

ORCloseKey

ORCreateKey

OREnumKey

OROpenKey