RegSetValueA 函数 (winreg.h)

项目
03/04/2024

设置指定注册表项的默认值或未命名值的数据。数据必须是文本字符串。

注意提供此函数只是为了与 16 位版本的 Windows 兼容。应用程序应使用 RegSetValueEx 函数。

语法

LSTATUS RegSetValueA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           DWORD  dwType,
  [in]           LPCSTR lpData,
  [in]           DWORD  cbData
);

参数

[in] hKey

打开的注册表项的句柄。密钥必须已使用KEY_SET_VALUE访问权限打开。有关详细信息，请参阅注册表项安全和访问权限。

此句柄由 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx 或 RegOpenKeyTransacted 函数返回。也可以是以下预定义键之一：

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

hKey 参数的子项的名称。函数设置指定子项的默认值。如果 lpSubKey 不存在，该函数将创建它。

键名称不区分大小写。

如果此参数为 NULL 或指向空字符串，则该函数将设置 由 hKey 标识的键的默认值。

有关详细信息，请参阅注册表元素大小限制。

[in] dwType

要存储的信息的类型。此参数必须是REG_SZ类型。若要存储其他数据类型，请使用 RegSetValueEx 函数。

[in] lpData

要存储的数据。此参数不能为 NULL。

[in] cbData

忽略此参数。函数根据 lpData 参数中的数据大小计算此值。

返回值

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

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

注解

如果 lpSubKey 参数指定的键不存在， 则 RegSetValue 函数将创建它。

如果通过显式调用 RegSetValueA 或在将 Windows.h 文件) 之前未定义 UNICODE 来 (使用此函数的 ANSI 版本，则 lpData 参数必须是 ANSI 字符串。字符串在存储到注册表中之前会转换为 Unicode。

注意

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

要求

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