ClusterGroupOpenEnum function (clusapi.h)

Article
02/22/2024

Opens an enumerator for iterating through a group's resources and/or the nodes that are included in its list of preferred owners. The PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM type defines a pointer to this function.

Syntax

HGROUPENUM ClusterGroupOpenEnum(
  [in] HGROUP hGroup,
  [in] DWORD  dwType
);

Parameters

[in] hGroup

A handle to the group to be enumerated.

[in] dwType

A bitmask that describes the cluster objects to be enumerated. The following are valid values of the CLUSTER_GROUP_ENUM enumeration.

CLUSTER_GROUP_ENUM_CONTAINS (1)

Enumerates the resources in the group.

CLUSTER_GROUP_ENUM_NODES (2)

Enumerates the nodes in the preferred owners list of the group.

CLUSTER_GROUP_ENUM_ALL (3)

Enumerates the resources in the group and the preferred owners of the group.

Return value

If the operation succeeds, ClusterGroupOpenEnum returns a handle to an enumerator that can be passed to the ClusterGroupEnum function.

If the operation fails, the function returns NULL. For more information about the error, call the function GetLastError.

Remarks

Do not call ClusterGroupOpenEnum from any resource DLL entry point function. ClusterGroupOpenEnum can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

Examples

See Enumerating Objects.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll