Función SHDeleteKeyA (shlwapi.h)

Elimina una subclave y todos sus descendientes. Esta función quita la clave y todos los valores de la clave del Registro.

Sintaxis

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

Parámetros

[in] hkey

Tipo: HKEY de

Identificador de una clave del Registro abierta o una de las siguientes claves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Tipo: LPCTSTR de

Dirección de una cadena terminada en NULL que especifica el nombre de la clave que se va a eliminar.

Valor devuelto

Tipo: LSTATUS de

Devuelve ERROR_SUCCESS si se ejecuta correctamente o un código de error distinto de cero definido en Winerror.h de lo contrario. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para recuperar una descripción genérica del error.

Observaciones

Como alternativa, use el RegDeleteKey o función RegDeleteTree.

Nota

El encabezado shlwapi.h define SHDeleteKey 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlwapi.h
biblioteca de	Shlwapi.lib
DLL de	Shlwapi.dll (versión 4.71 o posterior)