Función RegDeleteTreeA (winreg.h)

  • Artículo

Elimina las subclaves y los valores de la clave especificada de forma recursiva.

Sintaxis

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

Parámetros

[in] hKey

Identificador de una clave del Registro abierta. La clave debe haberse abierto con los siguientes derechos de acceso: DELETE, KEY_ENUMERATE_SUB_KEYS y KEY_QUERY_VALUE. Para obtener más información, consulte Derechos de acceso y seguridad de clave del Registro.

Este identificador lo devuelve la función RegCreateKeyEx, RegCreateKeyTransacted, RegOpenKeyEx o RegOpenKeyTransacted , o bien puede ser una de las siguientes claves predefinidas:

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in, optional] lpSubKey

El nombre de la clave. Esta clave debe ser una subclave de la clave identificada por el parámetro hKey . Si este parámetro es NULL, se eliminan las subclaves y los valores de hKey .

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si la función no se ejecuta correctamente, el valor devuelto es un código de error distinto de cero definido en Winerror.h. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para obtener una descripción genérica del error.

Comentarios

Si la clave tiene valores, debe abrirse con KEY_SET_VALUE o se producirá un error en esta función con ERROR_ACCESS_DENIED.

Para compilar una aplicación que use esta función, defina _WIN32_WINNT como 0x0600 o posterior. Para obtener más información, vea Uso de los encabezados de Windows.

Nota

En versiones heredadas de Windows, esta API también se expone mediante kernel32.dll.

Nota

El encabezado winreg.h define RegDeleteTree como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado winreg.h (incluya Windows.h)
Library Advapi32.lib
Archivo DLL Advapi32.dll

Consulte también

RegDeleteKey

RegDeleteKeyEx

RegDeleteKeyTransacted

Funciones del Registro