SHRegWriteUSValueW 函数 (shlwapi.h)

将值写入用户特定的子树中的注册表子项(HKEY_CURRENT_USER或HKEY_LOCAL_MACHINE)。

语法

LSTATUS SHRegWriteUSValueW(
  [in]         HUSKEY     hUSKey,
               LPCWSTR    pwzValue,
  [in]         DWORD      dwType,
  [in]         const void *pvData,
  [in]         DWORD      cbData,
  [in]         DWORD      dwFlags
);

参数

[in] hUSKey

类型:HUSKEY

当前打开的注册表子项的句柄。 子项必须使用KEY_SET_VALUE访问权限打开。 有关详细信息,请参阅 注册表项安全和访问权限

可以通过 SHRegOpenUSKey 函数获取此句柄。

pwzValue

待定

[in] dwType

类型:DWORD

要在 pszValue指定的值中存储的数据的类型。 Winnt.h 和 Wdm.h 中定义的以下注册表值类型之一。

REG_NONE(0x00000000)

REG_SZ(0x00000001)

REG_EXPAND_SZ(0x00000002)

REG_BINARY(0x00000003)

REG_DWORD(0x00000004)

REG_DWORD_LITTLE_ENDIAN(0x00000004)

REG_DWORD_BIG_ENDIAN(0x00000005)

REG_MULTI_SZ(0x00000007)

REG_RESOURCE_LIST(0x00000008)

REG_FULL_RESOURCE_DESCRIPTOR(0x00000009)

REG_RESOURCE_REQUIREMENTS_LIST (0x0000000A)

REG_QWORD(0x0000000B)

REG_QWORD_LITTLE_ENDIAN(0x0000000B)

[in] pvData

类型:const void*

指向要为 pszValue指定的值设置的数据的指针。 对于基于字符串的类型(如REG_SZ),字符串必须以 null 结尾。 使用REG_MULTI_SZ数据类型时,字符串必须以两个 null 字符结尾。 路径中的反斜杠前面必须是另一个反斜杠作为转义字符。 例如,指定“C:\mydir\myfile”来存储字符串“C:\mydir\myfile”。

[in] cbData

类型:DWORD

pvData 参数指向的数据的大小(以字节为单位)。 如果数据的类型为 REG_SZ、REG_EXPAND_SZ 或 REG_MULTI_SZ,cbData 必须包含终止 null 字符或字符的大小。

[in] dwFlags

类型:DWORD

指示应将数据写入到的子树的标志。 以下一个或多个值:

SHREGSET_HKCU(0x00000001)

仅当 pszValue 中指定的名称值当前不存在于指定的子项下时,才写入 HKEY_CURRENT_USER

SHREGSET_FORCE_HKCU(0x00000002)

写入 HKEY_CURRENT_USER。 如果 pszValue 中指定的名称值已存在,则会覆盖该值。

SHREGSET_HKLM(0x00000004)

仅当 pszValue 中指定的名称值当前不存在于指定的子项下时,才写入 HKEY_LOCAL_MACHINE

SHREGSET_FORCE_HKLM(0x00000008)

写入 HKEY_LOCAL_MACHINE。 如果 pszValue 中指定的名称值已存在,则会覆盖该值。

SHREGSET_DEFAULT(0x00000006)

等效于 (SHREGSET_FORCE_HKCU | SHREGSET_HKLM)。

返回值

类型:LSTATUS

如果成功,则返回ERROR_SUCCESS;否则,在 Winerror.h 中定义的非零错误代码。 可以将 FormatMessage 函数与FORMAT_MESSAGE_FROM_SYSTEM标志一起使用来检索错误的泛型说明。

言论

若要使用 SHRegWriteUSValue,必须先使用 SHRegOpenUSKey打开密钥。 打开密钥后,可以根据需要多次使用 SHRegWriteUSValue

如果只需要编写单个值,则应使用 SHRegSetUSValue,这将打开密钥并写入值。

如果需要在同一个键上写入多个值,则对 SHRegWriteUSValue 的多次调用通常比 SHRegSetUSValue更高效,因为密钥只打开一次。

注意

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

要求

要求 价值
最低支持的客户端 Windows 2000 Professional、Windows XP [仅限桌面应用]
支持的最低服务器 Windows 2000 Server [仅限桌面应用]
目标平台 窗户
标头 shlwapi.h
Shlwapi.lib
DLL Shlwapi.dll(版本 4.71 或更高版本)

另请参阅

注册表值类型