Función RegUnLoadKeyA (winreg.h)

Artículo
11/20/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 de 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 función RegConnectRegistry o uno de los siguientes identificadores predefinidos:

HKEY_LOCAL_MACHINEHKEY_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 de .

Los nombres de clave no distinguen mayúsculas de minúsculas.

Para obtener más información, consulte límites de tamaño de elemento del Registro .

Valor devuelto

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

Si se produce un error en la función, 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.

Observaciones

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 basa 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 obtener más información, vea En 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 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 [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	winreg.h (incluya Windows.h)
biblioteca de	Advapi32.lib
DLL de	Advapi32.dll