RegSaveKeyA 函数 (winreg.h)

将指定的键及其所有子项和值以标准格式保存到新文件中。

若要指定保存的密钥或 hive 的格式,请使用 RegSaveKeyEx 函数。

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

语法

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

参数

[in] hKey

打开的注册表项的句柄。

此句柄由 RegCreateKeyExRegOpenKeyEx 函数返回,也可以是以下 预定义键之一

HKEY_CLASSES_ROOT
HKEY_CURRENT_USER

[in] lpFile

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

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

[in, optional] lpSecurityAttributes

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

返回值

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

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

如果文件已存在,该函数将失败并出现ERROR_ALREADY_EXISTS错误。

言论

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

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

可以在对 RegLoadKeyRegReplaceKeyRegRestoreKey 函数的后续调用中使用 RegSaveKey 创建的文件。 如果 RegSaveKey 部分操作失败,则文件将损坏,随后会调用 RegLoadKeyRegReplaceKeyRegRestoreKey 文件将失败。

不建议将 RegSaveKeyRegRestoreKey 一起使用以复制注册表中的子树。 此方法不会触发通知,并且可能会使其他应用程序使用的句柄失效。 请改用 SHCopyKey 函数或 RegCopyTree 函数。

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

注意

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

要求

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

另请参阅

RegCreateKeyEx

RegDeleteKey

RegLoadKey

RegReplaceKey

RegRestoreKey

RegSaveKeyEx

注册表文件

注册表函数

SECURITY_ATTRIBUTES