RegSaveKeyExA 函数（winreg.h）

项目
11/20/2024

以指定格式将指定键及其所有子项和值保存到注册表文件中。

备份或还原系统状态（包括系统文件和注册表配置单元）的应用程序应使用卷影复制服务而不是注册表功能。

语法

LSTATUS RegSaveKeyExA(
  [in]           HKEY                        hKey,
  [in]           LPCSTR                      lpFile,
  [in, optional] const LPSECURITY_ATTRIBUTES lpSecurityAttributes,
  [in]           DWORD                       Flags
);

参数

[in] hKey

打开的注册表项的句柄。

此函数不支持 HKEY_CLASSES_ROOT 预定义键。

[in] lpFile

要在其中保存指定键和子项的文件的名称。如果文件已存在，该函数将失败。

新文件具有存档属性。

如果字符串不包含路径，则会在本地密钥的调用进程的当前目录中创建该文件，或者在远程密钥的 %systemroot%\system32 目录中创建该文件。

[in, optional] lpSecurityAttributes

指向 SECURITY_ATTRIBUTES 结构的指针，该结构指定新文件的安全描述符。如果 lpSecurityAttributesNULL，则该文件将获取默认的安全描述符。文件的默认安全描述符中的 ACL 继承自其父目录。

[in] Flags

保存的密钥或配置单元的格式。此参数可以是下列值之一。

价值	意义
REG_STANDARD_FORMAT 1	密钥或配置单元以标准格式保存。标准格式是 Windows 2000 支持的唯一格式。
REG_LATEST_FORMAT 2	密钥或配置单元以最新格式保存。从 Windows XP 开始，支持最新格式。以此格式保存密钥或配置单元后，无法将其加载到早期系统上。
REG_NO_COMPRESSION 4	配置单元在没有压缩的情况下保存，以加快保存操作的速度。 hKey 参数必须在 HKEY_LOCAL_MACHINE 或 HKEY_USERS下指定 hive 的根。例如，HKLM\SOFTWARE 是 hive 的根。

返回值

如果函数成功，则返回值ERROR_SUCCESS。

如果函数失败，则返回值为 Winerror.h 中定义的非零错误代码。可以将 FormatMessage 函数与FORMAT_MESSAGE_FROM_SYSTEM标志一起使用，以获取错误的泛型说明。

如果在对此函数的一次调用中指定了上面列出的标志参数的多个可能值，或者指定了两个或更多个值，或者指定REG_NO_COMPRESSION并且 hKey 指定不是 hive 根的键，则此函数将返回ERROR_INVALID_PARAMETER。

言论

与 RegSaveKey不同，此函数不支持 HKEY_CLASSES_ROOT 预定义密钥。

如果 hKey 表示远程计算机上的密钥，则 lpFile 描述的路径相对于远程计算机。

RegSaveKeyEx 函数仅保存非易失性密钥。它不保存易失键。键在创建时是可变的或非易失性的;请参阅 RegCreateKeyEx。

可以在对 RegLoadKey、RegReplaceKey或 RegRestoreKey 函数的后续调用中使用 RegSaveKeyEx 创建的文件。如果 RegSaveKeyEx 在其操作过程中失败，则文件将损坏，随后将调用 RegLoadKey、RegReplaceKey，或 文件 RegRestoreKey 将失败。

不建议在注册表中使用 RegSaveKeyEx 和 RegRestoreKey 来复制子树。此方法不会触发通知，并且可能会使其他应用程序使用的句柄失效。请改用 SHCopyKey 函数或 RegCopyTree 函数。

调用进程必须启用SE_BACKUP_NAME特权。有关详细信息，请参阅使用特殊特权运行。

注意

winreg.h 标头将 RegSaveKeyEx 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。有关详细信息，请参阅函数原型的约定。

要求

要求	价值
最低支持的客户端	Windows XP [仅限桌面应用]
支持的最低服务器	Windows Server 2003 [仅限桌面应用]
目标平台	窗户
标头	winreg.h （包括 Windows.h）
库	Advapi32.lib
DLL	Advapi32.dll