ClusterOpenEnum 函数 (clusapi.h)

项目
08/22/2023

打开枚举器以循环访问群集中的群集对象。 PCLUSAPI_CLUSTER_OPEN_ENUM类型定义指向此函数的指针。

语法

HCLUSENUM ClusterOpenEnum(
  [in] HCLUSTER hCluster,
  [in] DWORD    dwType
);

参数

[in] hCluster

群集的句柄。

[in] dwType

描述要枚举的对象类型的位掩码。 CLUSTER_ENUM枚举的以下一个或多个值有效。

CLUSTER_ENUM_NODE (1 (0x1) )

枚举群集中的节点。

CLUSTER_ENUM_RESTYPE (2 (0x2) )

枚举群集中的资源类型。

CLUSTER_ENUM_RESOURCE (4 (0x4) )

枚举群集中的资源。

CLUSTER_ENUM_GROUP (8 (0x8) )

枚举群集中的组。

CLUSTER_ENUM_NETWORK (16 (0x10) )

枚举群集中的网络。

CLUSTER_ENUM_NETINTERFACE (32 (0x20) )

枚举群集中的网络接口。

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000) )

枚举群集使用的群集共享卷。

注意与大多数其他枚举位掩码不同，此值必须单独使用。请勿使用 OR 运算符将其与其他位掩码组合在一起。

Windows Server 2008： 在 Windows Server 2008 R2 之前不支持 CLUSTER_ENUM_SHARED_VOLUME_RESOURCE 值。

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000) )

枚举群集用于内部通信的网络。网络按 SetClusterNetworkPriorityOrder 建立的优先级从高到低的顺序进行枚举。

注意与大多数其他枚举位掩码不同，此值必须单独使用。请勿使用 OR 运算符将其与其他位掩码组合在一起。

CLUSTER_ENUM_ALL ( (CLUSTER_ENUM_NODE |CLUSTER_ENUM_RESTYPE |CLUSTER_ENUM_RESOURCE |CLUSTER_ENUM_GROUP |CLUSTER_ENUM_NETWORK |CLUSTER_ENUM_NETINTERFACE) )

枚举所有群集对象。

返回值

如果操作成功， ClusterOpenEnum 会向群集枚举器返回句柄。

如果操作失败，函数将返回 NULL。有关错误的详细信息，请调用函数 GetLastError。

注解

应用程序调用 ClusterOpenEnum 函数来创建特定类型的枚举器。 ClusterOpenEnum 可以创建枚举器，用于循环访问组、节点、资源类型、资源或所有这些组。例如，应用程序可以通过在 dwType 参数中指定CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NODE来调用 ClusterOpenEnum 以获取群集中所有节点和组的枚举。 ClusterOpenEnum 返回一个句柄，该句柄可以传递给 ClusterEnum 以访问每个群集组或节点，并传递给 ClusterCloseEnum 以释放枚举器。

示例

请参阅枚举对象。

要求

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

另请参阅

群集管理功能

ClusterCloseEnum

ClusterEnum

SetClusterNetworkPriorityOrder

通过