DestroyClusterGroup function (clusapi.h)

Article
02/22/2024

Deletes the specified group from a cluster. Unlike DeleteClusterGroup the group can contain resources and it can be online. The PCLUSAPI_DESTROY_CLUSTER_GROUP type defines a pointer to this function.

Syntax

DWORD DestroyClusterGroup(
  [in] HGROUP hGroup
);

Parameters

[in] hGroup

This parameter takes a handle to the cluster group to be destroyed.

Return value

This function returns a system error code. If the operation completes successfully the function returns ERROR_SUCCESS (0). Any other returned system error code would indicate that the operation failed.

Remarks

The PCLUSAPI_DESTROY_CLUSTER_GROUP type defines a pointer to this function.

DestroyClusterGroup does not close the group handle specified by the hGroup parameter. To avoid memory leaks, be sure to close this handle with the CloseClusterGroup function.

Do not call DestroyClusterGroup from a resource DLL. For more information, see Function Calls to Avoid in Resource DLLs.

Requirements

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