ClusterRegQueryValue 函数 (clusapi.h)

项目
03/05/2024

返回与打开的群集数据库密钥的值关联的名称、类型和数据组件。

语法

LONG ClusterRegQueryValue(
  [in]                HKEY    hKey,
  [in]                LPCWSTR lpszValueName,
  [out, optional]     LPDWORD lpdwValueType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

参数

[in] hKey

要查询的群集数据库密钥的句柄。

[in] lpszValueName

指向以 null 结尾的 Unicode 字符串的指针，该字符串包含要查询的值的名称。

[out, optional] lpdwValueType

指向键的值类型的指针。如果类型不是必需的，此参数可以为 NULL ;否则，通过此参数返回的值为以下值之一。

REG_BINARY (3)

任意格式的二进制数据。

REG_DWORD (4)

32 位数字。

REG_DWORD_BIG_ENDIAN (5)

以 big-endian 格式存储的 32 位数字。

REG_EXPAND_SZ (2)

一个以 null 结尾的 Unicode 字符串，包含对环境变量 (例如“%PATH%”) 的未扩展引用。

REG_MULTI_SZ (6)

以 null 结尾的字符串序列，由空字符串 (\0) 终止。

以下是一个示例：

String1\0String2\0String3\0LastString\0\0

第一个 \0 终止第一个字符串，第二个 \0 终止最后一个字符串，最后一个 \0 终止序列。请注意，必须将最终终止符纳入字符串的长度。

REG_NONE (0)

没有定义的值类型。

REG_QWORD (11)

64 位数字。

REG_SZ (1)

以 Null 值结束的 Unicode 字符串。

[out, optional] lpData

指向值数据的指针。如果不需要数据，此参数可以为 NULL 。

[in, out, optional] lpcbData

输入时，指针指向 lpbData 参数指向的缓冲区中的字节计数。输出时，指向值数据中字节计数的指针，如果调用方传入有效的指针，则该值放置在 lpbData 的内容中。

仅当 lpbData 也为 NULL 时 ，lpbData 参数才能为 NULL。

返回值

函数返回以下值之一。

返回代码/值	说明
ERROR_SUCCESS 0 (0x0)	操作成功。
ERROR_MORE_DATA 234 (0xEA)	lpbData 指向的缓冲区不够大，无法容纳值的数据。 ClusterRegQueryValue 将所需大小存储在 lpbData 的内容中。

注解

如果 lpbData 为 NULL，ClusterRegQueryValue 函数将返回ERROR_SUCCESS并将值数据的大小存储在 lpbData 的内容中。此信息允许调用方正确分配用于保存数据的缓冲区。

如果 lpdwValueType 设置为 REG_SZ、 REG_MULTI_SZ 或 REG_EXPAND_SZ，则 lpbData 还包括 NULL 终止符。

要求

要求	值
最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows Server 2008 企业版、Windows Server 2008 Datacenter
目标平台	Windows
标头	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll

另请参阅

ClusterRegOpenKey

通过