ClusterGroupEnum 函数 (clusapi.h)

枚举组中的资源或作为组的首选所有者的节点,并在每次调用时返回资源或节点的名称。 PCLUSAPI_CLUSTER_GROUP_ENUM类型定义指向此函数的指针。

语法

DWORD ClusterGroupEnum(
  [in]      HGROUPENUM hGroupEnum,
  [in]      DWORD      dwIndex,
  [out]     LPDWORD    lpdwType,
  [out]     LPWSTR     lpszResourceName,
  [in, out] LPDWORD    lpcchName
);

参数

[in] hGroupEnum

ClusterGroupOpenEnum 函数返回的组枚举句柄。

[in] dwIndex

要返回的资源或节点的索引。 首次调用 ClusterGroupEnum 时,此参数应为零,然后针对后续调用递增。

[out] lpdwType

指向 ClusterGroupEnum 返回的对象类型的指针。 下面是 CLUSTER_GROUP_ENUM 枚举的有效值。

CLUSTER_GROUP_ENUM_CONTAINS (1)

对象是组中的资源之一。

CLUSTER_GROUP_ENUM_NODES (2)

对象是组的首选所有者列表中的节点之一。

[out] lpszResourceName

指向以 null 结尾的 Unicode 字符串的指针,该字符串包含返回的资源或节点的名称。

[in, out] lpcchName

指向 lpszResourceName 缓冲区大小(字符计数)的指针。 在输入时,指定缓冲区可以容纳的最大字符数,包括终止 NULL。 在输出时,指定结果名称中的字符数,不包括终止 NULL。

返回值

函数可以返回以下值之一。

返回代码/值 说明
ERROR_SUCCESS
0
操作已成功完成。
ERROR_MORE_DATA
234 (0xEA)
更多数据可用。 如果 lpszResourceName 指向的缓冲区不够大,无法保存结果,则返回此值。 lpcchName 参数返回结果中的字符数,不包括终止 NULL。
ERROR_NO_MORE_ITEMS
259 (0x103)
没有更多可用数据。 如果没有更多要返回的资源或节点,则返回此值。
 

如果操作由于ERROR_NO_MORE_ITEMS或ERROR_MORE_DATA值描述的问题以外的问题而未成功,则 ClusterGroupEnum 将返回系统错误代码

注解

请注意, lpcchName 指的是字符计数而不是字节计数,并且返回的大小不包括计数中的终止 NULL 。 有关调整缓冲区大小的详细信息,请参阅 数据大小约定

不要从任何资源 DLL 入口点函数调用 ClusterGroupEnum 。 可以从工作线程安全地调用 ClusterGroupEnum。 有关详细信息,请参阅 在资源 DLL 中对避免的函数调用

示例

请参阅 枚举对象

要求

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

另请参阅

ClusterGroupCloseEnum

ClusterGroupOpenEnum

组管理功能