Función RegDeleteKeyA (winreg.h)
Elimina una subclave y sus valores. Tenga en cuenta que los nombres de clave no distinguen mayúsculas de minúsculas.
Windows de 64 bits: En WOW64, las aplicaciones de 32 bits ven un árbol del Registro que es independiente del árbol del Registro que ven las aplicaciones de 64 bits. Para permitir que una aplicación elimine una entrada en la vista del Registro alternativa, use la función RegDeleteKeyEx .
Sintaxis
LSTATUS RegDeleteKeyA(
[in] HKEY hKey,
[in] LPCSTR lpSubKey
);
Parámetros
[in] hKey
Identificador de una clave del Registro abierta. Los derechos de acceso de esta clave no afectan a la operación de eliminación. Para obtener más información sobre los derechos de acceso, consulte Derechos de acceso y seguridad de la clave del Registro.
La función RegCreateKeyEx o RegOpenKeyEx devuelve este identificador, 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] lpSubKey
El nombre de la clave que se va a eliminar. Debe ser una subclave de la clave que identifica hKey , pero no puede tener subclaves. Este parámetro no puede ser NULL.
La función abre la subclave con el derecho de acceso DELETE.
Los nombres de clave no distinguen mayúsculas de minúsculas.
Para obtener más información, vea Límites de tamaño de elemento del Registro.
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. Para obtener una descripción genérica del error, puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM.
Comentarios
Una clave eliminada no se quita hasta que se cierra el último identificador.
La subclave que se va a eliminar no debe tener subclaves. Para eliminar una clave y todas sus subclaves, debe enumerar las subclaves y eliminarlas individualmente. Para eliminar las claves de forma recursiva, use la función RegDeleteTree o SHDeleteKey .
Ejemplos
Para obtener un ejemplo que usa esta función, consulte Eliminación de una clave con subclaves.
Nota:
En versiones heredadas de Windows, esta API también se expone mediante kernel32.dll.
Nota
El encabezado winreg.h define RegDeleteKey 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
Cliente mínimo compatible | Windows 2000 Professional [solo aplicaciones de escritorio] |
Servidor mínimo compatible | Windows 2000 Server [solo aplicaciones de escritorio] |
Plataforma de destino | Windows |
Encabezado | winreg.h (incluye Windows.h) |
Library | Advapi32.lib |
Archivo DLL | Advapi32.dll |