Función RegSaveKeyA (winreg.h)

Artículo
11/20/2024

Guarda la clave especificada y todos sus subclaves y valores en un nuevo archivo, en el formato estándar.

Para especificar el formato de la clave guardada o subárbol, use la función regSaveKeyEx .

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 RegSaveKeyA(
  [in]           HKEY                        hKey,
  [in]           LPCSTR                      lpFile,
  [in, optional] const LPSECURITY_ATTRIBUTES lpSecurityAttributes
);

Parámetros

[in] hKey

Identificador de una clave del Registro abierta.

Este identificador lo devuelve la función RegCreateKeyEx o regOpenKeyEx o puede ser una de las siguientes claves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_USER

[in] lpFile

Nombre del archivo en el que se van a guardar la clave y las subclaves especificadas. Si el archivo ya existe, se produce un error en la función.

Si la cadena no incluye una ruta de acceso, el archivo se crea en el directorio actual del proceso de llamada para una clave local o en el directorio \system32 de %systemroot%para una clave remota. El nuevo archivo tiene el atributo archive.

[in, optional] lpSecurityAttributes

Puntero a una estructura SECURITY_ATTRIBUTES que especifica un descriptor de seguridad para el nuevo archivo. Si lpSecurityAttributes es NULL, el archivo obtiene un descriptor de seguridad predeterminado. Las ACL de un descriptor de seguridad predeterminado para un archivo se heredan de su directorio primario.

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.

Si el archivo ya existe, se produce un error en la función ERROR_ALREADY_EXISTS error.

Observaciones

Si hKey representa una clave en un equipo remoto, la ruta de acceso descrita por lpFile es relativa al equipo remoto.

La función regSaveKey de solo guarda claves no volátiles. No guarda claves volátiles. Una clave se convierte en volátil o no volátil en su creación; consulte RegCreateKeyEx.

Puede usar el archivo creado por regSaveKey en llamadas posteriores a las funciones RegLoadKey, RegReplaceKeyo RegRestoreKey. Si regSaveKey produce un error parcial a través de su operación, el archivo estará dañado y las llamadas posteriores a RegLoadKey, RegReplaceKeyo RegRestoreKey para el archivo producirá un error.

No se recomienda usar RegSaveKey junto con RegRestoreKey para copiar subárboles en el registro. Este método no desencadena notificaciones y puede invalidar los identificadores usados por otras aplicaciones. En su lugar, use la función SHCopyKey o la función RegCopyTree.

El proceso de llamada debe tener habilitado el privilegio SE_BACKUP_NAME. Para obtener más información, vea En ejecución con privilegios especiales.

Nota

El encabezado winreg.h define RegSaveKey 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