SHRegWriteUSValueA 函数 (shlwapi.h)

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

语法

LSTATUS SHRegWriteUSValueA(
  [in] HUSKEY     hUSKey,
  [in] LPCSTR     pszValue,
  [in] DWORD      dwType,
  [in] const void *pvData,
  [in] DWORD      cbData,
  [in] DWORD      dwFlags
);

参数

[in] hUSKey

类型: HUSKEY

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

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

[in] pszValue

类型: LPCTSTR

指向以 null 结尾的字符串的指针,该字符串指定值的名称。 此值是 hUSKey 指定的子项中的条目。 如果子项中尚不存在具有此名称的值,则会添加该值。

如果此参数为 NULL 或空字符串,则该函数将设置子项默认值的类型和数据。

[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 中定义的非零错误代码。 可以使用带有 FORMAT_MESSAGE_FROM_SYSTEM 标志的 FormatMessage 函数来检索错误的泛型说明。

注解

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

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

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

注意

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

要求

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

另请参阅

注册表值类型