通过

SHRegGetUSValueA 函数 （shlwapi.h）

  • 项目

从用户特定的子树（HKEY_CURRENT_USER或HKEY_LOCAL_MACHINE）中的注册表子项中检索值。

语法

LSTATUS SHRegGetUSValueA(
  [in]                LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [in, out, optional] DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *pcbData,
  [in]                BOOL   fIgnoreHKCU,
  [in, optional]      void   *pvDefaultData,
  [in]                DWORD  dwDefaultDataSize
);

参数

[in] pszSubKey

类型：LPCTSTR

指向以 null 结尾的字符串的指针，该字符串的名称相对于 HKEY_LOCAL_MACHINE 和 HKEY_CURRENT_USER。 例如：“Software\MyCompany\MyProduct”。

[in, optional] pszValue

类型：LPCTSTR

指向具有值名称的以 null 结尾的字符串的指针。 此值可以 NULL。

[in, out, optional] pdwType

类型：DWORD*

指向 DWORD 的指针，用于接收存储在检索值中的数据的类型。 使用默认值时，输入 pdwType 是默认值的类型。 有关可能的值，请参阅 注册表数据类型。 如果不需要类型信息，则可以将此参数 NULL。

[out, optional] pvData

类型：void*

指向接收值数据的缓冲区的指针。

[in, out, optional] pcbData

类型：DWORD*

指向变量的指针，该变量指定由 pvData指向的缓冲区的大小（以字节为单位）。 SHRegGetUSValue 返回时， 包含复制到 pvData的数据的大小。

[in] fIgnoreHKCU

类型：BOOL

一个变量，指定要在哪个键下查找。 如果设置为 true ，SHRegGetUSValue 将忽略 HKEY_CURRENT_USER 并从 HKEY_LOCAL_MACHINE下的键返回值。

[in, optional] pvDefaultData

类型：void*

指向接收值默认数据的缓冲区的指针。

[in] dwDefaultDataSize

类型：DWORD

pvDefaultData指向的缓冲区的长度（以字节为单位）。

返回值

类型：LSTATUS

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

言论

当 fIgnoreHKCU 设置为 true时，SHRegGetUSValue 返回 HKEY_LOCAL_MACHINE下的键中的值。 如果设置为 FALSE，SHRegGetUSValue 首先尝试从 HKEY_CURRENT_USER下的键返回值。 但是，如果在 HKEY_CURRENT_USER下找不到该键，则该值将从 HKEY_LOCAL_MACHINE下的键返回。 如果两个键都不存在，或者发生错误并且 dwDefaultDataSize 为非零，则将默认数据复制到 pvData，ERROR_SUCCESS返回。 ERROR_SUCCESS返回默认和非默认数据，并且无法区分要复制到 pvData的值。 若要防止使用默认数据，请将 pvDefaultData 设置为 NULL，并将 dwDefaultDataSize 设置为零。

每次使用密钥时，此函数都会打开密钥。 如果代码涉及从同一个键获取一系列值，则使用 SHRegOpenUSKey 打开密钥一次，然后使用 SHRegQueryUSValue 检索数据更为高效。

注意

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

要求

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