nf-clusapi-clustergroupopenenumex.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:clusapi.ClusterGroupOpenEnumEx	ClusterGroupOpenEnumEx function (clusapi.h)	Opens a handle to the group enumeration.	ClusterGroupOpenEnumEx ClusterGroupOpenEnumEx function [Failover Cluster] PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX function [Failover Cluster] clusapi/ClusterGroupOpenEnumEx clusapi/PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX mscs.clustergroupopenenumex	mscs\clustergroupopenenumex.htm	MsCS	1BEF74A2-8230-4698-A3B7-FC2AA495D294	12/05/2018	ClusterGroupOpenEnumEx, ClusterGroupOpenEnumEx function [Failover Cluster], PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX, PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX function [Failover Cluster], clusapi/ClusterGroupOpenEnumEx, clusapi/PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX, mscs.clustergroupopenenumex	clusapi.h		Windows	None supported	Windows Server 2012										ClusAPI.lib	ClusAPI.dll		Windows			19H1	ClusterGroupOpenEnumEx clusapi/ClusterGroupOpenEnumEx	c++	APIRef kbSyntax	DllExport	ClusAPI.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-0.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-1.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-2.dll	ClusterGroupOpenEnumEx

ClusterGroupOpenEnumEx function

-description

Opens a handle to the group enumeration.The PCLUSAPI_CLUSTER_GROUP_OPEN_ENUM_EX type defines a pointer to this function.

-parameters

-param hCluster [in]

The handle to the cluster on which the enumeration will be performed.

-param lpszProperties

A pointer to a list of names of common properties.

-param cbProperties [in]

The size, in bytes, of the lpszProperties field.

-param lpszRoProperties

A pointer to a list of names of read-only common properties.

-param cbRoProperties [in]

The size, in bytes, of the lpszRoProperties field.

-param dwFlags [in]

Reserved for future use. This value must be 0.

-returns

If the operation is successful, the function returns a handle to the enumeration.

If the operation fails, the function returns NULL.

-remarks

The ClusterGroupOpenEnumEx function connects to the cluster service via remote procedure call (RPC) and gathers all of the data to handle the entire enumeration. After the RPC call completes, the data is maintained locally. The HGROUPENUMEX handle contains all of the data required to satisfy the enumeration. Additional calls to ClusterGroupEnumEx or ClusterGroupGetEnumCountEx do not connect to the cluster.