GetClusterFromGroup function (clusapi.h)

Article
02/22/2024

Returns a handle to the cluster associated with a group. The PCLUSAPI_GET_CLUSTER_FROM_GROUP type defines a pointer to this function.

Syntax

HCLUSTER GetClusterFromGroup(
  [in] HGROUP hGroup
);

Parameters

[in] hGroup

Handle to the group.

Return value

If the operation succeeds, the function returns a handle to the cluster that owns the group.

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

Remarks

For hGroup to be a valid handle, there must necessarily be an open cluster handle (see OpenClusterGroup). GetClusterFromGroup returns another instance of the handle from which hGroup was obtained.

Be sure to call CloseCluster on the handle returned from GetClusterFromGroup before the handle goes out of scope. Closing this handle does not invalidate hGroup or the cluster handle from which hGroup was obtained.

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