DeleteClusterGroup function (clusapi.h)

Article
02/22/2024

Removes an offline and empty group from a cluster. The PCLUSAPI_DELETE_CLUSTER_GROUP type defines a pointer to this function.

Syntax

DWORD DeleteClusterGroup(
  [in] HGROUP hGroup
);

Parameters

[in] hGroup

Handle to the group to be removed. You must close this handle separately.

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_DELETE_CLUSTER_GROUP type defines a pointer to this function.

Because the DeleteClusterGroup function only removes groups that are empty, a group must not have any resources if it is to be successfully deleted. To delete a group with resources, use the DestroyClusterGroup function.

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

Do not call DeleteClusterGroup 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 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll