RegQueryInfoKeyA 函数 (winreg.h)

项目
08/27/2023

检索有关指定注册表项的信息。

语法

LSTATUS RegQueryInfoKeyA(
  [in]                HKEY      hKey,
  [out, optional]     LPSTR     lpClass,
  [in, out, optional] LPDWORD   lpcchClass,
                      LPDWORD   lpReserved,
  [out, optional]     LPDWORD   lpcSubKeys,
  [out, optional]     LPDWORD   lpcbMaxSubKeyLen,
  [out, optional]     LPDWORD   lpcbMaxClassLen,
  [out, optional]     LPDWORD   lpcValues,
  [out, optional]     LPDWORD   lpcbMaxValueNameLen,
  [out, optional]     LPDWORD   lpcbMaxValueLen,
  [out, optional]     LPDWORD   lpcbSecurityDescriptor,
  [out, optional]     PFILETIME lpftLastWriteTime
);

参数

[in] hKey

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

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


   HKEY_CLASSES_ROOT
   HKEY_CURRENT_CONFIG
   HKEY_CURRENT_USER
   HKEY_LOCAL_MACHINE
   HKEY_PERFORMANCE_DATA
   HKEY_USERS

[out, optional] lpClass

指向接收密钥的用户定义类的缓冲区的指针。此参数可以为 NULL。

[in, out, optional] lpcchClass

指向变量的指针，该变量指定 lpClass 参数指向的缓冲区的大小（以字符为单位）。

大小应包含终止 null 字符。当函数返回时，此变量包含存储在缓冲区中的类字符串的大小。返回的计数不包括终止 null 字符。如果缓冲区不够大，函数将返回ERROR_MORE_DATA，并且变量包含字符串的大小（以字符为单位），而不计算终止 null 字符。

如果 lpClass 为 NULL， 则 lpcClass 可以为 NULL。

如果 lpClass 参数是有效的地址，但 lpcClass 参数不是（例如，它是 NULL），则该函数返回ERROR_INVALID_PARAMETER。

lpReserved

此参数是保留的，必须为 NULL。

[out, optional] lpcSubKeys

指向变量的指针，该变量接收指定键包含的子项数。此参数可以为 NULL。

[out, optional] lpcbMaxSubKeyLen

指向变量的指针，该变量接收具有最长名称的键子项的大小（以 ANSI 字符为单位），不包括终止 null 字符。此参数可以为 NULL。

[out, optional] lpcbMaxClassLen

指向变量的指针，该变量接收指定子键类的最长字符串的大小（以 ANSI 字符为单位）。返回的计数不包括终止 null 字符。此参数可以为 NULL。

[out, optional] lpcValues

指向接收与键关联的值数的变量的指针。此参数可以为 NULL。

[out, optional] lpcbMaxValueNameLen

指向变量的指针，该变量接收键的最长值名称的大小（以 ANSI 字符为单位）。大小不包括终止 null 字符。此参数可以为 NULL。

[out, optional] lpcbMaxValueLen

指向变量的指针，该变量接收键值中最长数据组件的大小（以字节为单位）。此参数可以为 NULL。

[out, optional] lpcbSecurityDescriptor

指向变量的指针，该变量接收密钥的安全描述符的大小（以字节为单位）。此参数可以为 NULL。

[out, optional] lpftLastWriteTime

指向接收上次写入时间的 FILETIME 结构的指针。此参数可以为 NULL。

函数设置 FILETIME 结构的成员，以指示上次修改键或其任何值条目的时间。

返回值

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

如果函数失败，则返回值为系统错误代码。

如果 lpClass 缓冲区太小，无法接收类的名称，则函数将返回ERROR_MORE_DATA。

注解

注意

在旧版 Windows 上，此 API 也由 kernel32.dll 公开。

要求

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