Función RegUnLoadKeyA (winreg.h)

Artículo
03/13/2024

Descarga la clave del Registro especificada y sus subclaves del Registro.

Las aplicaciones que realicen copias de seguridad o restaure el estado del sistema, incluidos los archivos del sistema y los subárboles del Registro, deben usar el Servicio de instantáneas de volumen en lugar de las funciones del Registro.

Sintaxis

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

Parámetros

[in] hKey

Identificador de la clave del Registro que se va a descargar. Este parámetro puede ser un identificador devuelto por una llamada a la función RegConnectRegistry o a uno de los siguientes identificadores predefinidos:

HKEY_LOCAL_MACHINE HKEY_USERS

[in, optional] lpSubKey

Nombre de la subclave que se va a descargar. La clave a la que hace referencia el parámetro lpSubKey debe haberse creado mediante la función RegLoadKey .

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. Puede usar la función FormatMessage con la marca FORMAT_MESSAGE_FROM_SYSTEM para obtener una descripción genérica del error.

Comentarios

Esta función quita un subárbol del Registro, pero no modifica el archivo que contiene la información del Registro. Un subárbol es un cuerpo discreto de claves, subclaves y valores que se raíz en la parte superior de la jerarquía del Registro.

El proceso de llamada debe tener los privilegios SE_RESTORE_NAME y SE_BACKUP_NAME en el equipo en el que reside el registro. Para más información, consulte Ejecución con privilegios especiales.

Nota

El encabezado winreg.h define RegUnLoadKey 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 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winreg.h (incluya Windows.h)
Library	Advapi32.lib
Archivo DLL	Advapi32.dll