RegEnumValueA 函数（winreg.h）

项目
11/20/2024

枚举指定打开的注册表项的值。每次调用键时，该函数都会复制一个索引值名称和数据块。

语法

LSTATUS RegEnumValueA(
  [in]                HKEY    hKey,
  [in]                DWORD   dwIndex,
  [out]               LPSTR   lpValueName,
  [in, out]           LPDWORD lpcchValueName,
                      LPDWORD lpReserved,
  [out, optional]     LPDWORD lpType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

参数

[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

[in] dwIndex

要检索的值的索引。对于对 RegEnumValue 函数的第一次调用，此参数应为零，然后为后续调用递增。

由于值没有排序，因此任何新值都将具有任意索引。这意味着该函数可以按任意顺序返回值。

[out] lpValueName

指向缓冲区的指针，该缓冲区接收值的名称作为 null-terminated 字符串。

此缓冲区必须足够大，才能包含终止 null 字符。

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

[in, out] lpcchValueName

指向变量的指针，该变量指定 lpValueName 参数所指向的缓冲区的大小（以字符为单位）。函数返回时，变量将接收存储在缓冲区中的字符数，不包括终止 null 字符。

如果由 lpValueName 指定的缓冲区不够大来保存数据，则函数将返回ERROR_MORE_DATA，并且 lpValueName 指向的变量中的缓冲区大小不会更改。在这种情况下，未定义 lpcchValueName 的内容。

注册表值名称限制为 32,767 字节。此函数的 ANSI 版本将此参数视为 SHORT 值。因此，如果指定的值大于 32,767 字节，则存在溢出，并且该函数可能会返回ERROR_MORE_DATA。

lpReserved

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

[out, optional] lpType

指向一个变量的指针，该变量接收一个代码，指示存储在指定值中的数据的类型。有关可能的类型代码的列表，请参阅注册表值类型。如果不需要类型代码，则可以将 lpType 参数 NULL。

[out, optional] lpData

指向接收值项数据的缓冲区的指针。如果不需要数据，则可以 NULL 此参数。

如果 lpDataNULL，l 为非NULL，则函数将数据存储 l指向的变量中的数据大小（以字节为单位）。这使应用程序能够确定为数据分配缓冲区的最佳方式。

[in, out, optional] lpcbData

指向变量的指针，该变量指定由 lpData 参数指向的缓冲区的大小（以字节为单位）。函数返回时，变量将接收存储在缓冲区中的字节数。

仅当 lpDataNULL时，此参数才能 NULL。

如果数据具有REG_SZ、REG_MULTI_SZ或REG_EXPAND_SZ类型，则此大小包括任何终止 null 字符或字符。有关详细信息，请参阅“备注”。

如果由 lpData 指定的缓冲区不足以容纳数据，则函数将返回ERROR_MORE_DATA，并将所需的缓冲区大小存储在 l指向的变量中。在这种情况下，未定义 lpData 的内容。

返回值

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

如果函数失败，则返回值为系统错误代码。如果没有更多可用值，该函数将返回ERROR_NO_MORE_ITEMS。

如果由 lpValueName 或 lpData 指定的缓冲区太小而无法接收该值，则函数将返回ERROR_MORE_DATA。

言论

若要枚举值，应用程序应最初调用 RegEnumValue 函数，并将 dwIndex 参数设置为零。然后，应用程序应递增 dwIndex，并调用 RegEnumValue 函数，直到没有更多值（直到函数返回ERROR_NO_MORE_ITEMS）。

应用程序还可以将 dwIndex 到对函数的第一次调用时最后一个值的索引，并递减索引，直到枚举具有索引 0 的值。若要检索最后一个值的索引，请使用 RegQueryInfoKey 函数。

使用 RegEnumValue时，应用程序不应调用任何可能更改要查询的密钥的注册表函数。

如果数据具有REG_SZ、REG_MULTI_SZ或REG_EXPAND_SZ类型，则字符串可能未使用正确的 null-terminating 字符存储。因此，即使函数返回ERROR_SUCCESS，应用程序也应确保在使用该字符串之前正确终止;否则，它可能会覆盖缓冲区。（请注意，REG_MULTI_SZ字符串应具有两个 null-terminating 字符。

若要确定名称和数据缓冲区的最大大小，请使用 RegQueryInfoKey 函数。

注意

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

例子

有关示例，请参阅枚举注册表子项。

注意

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

要求

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