CloseCluster function (clusapi.h)

Article
02/22/2024

Closes a cluster handle. The PCLUSAPI_CLOSE_CLUSTER type defines a pointer to this function.

Syntax

BOOL CloseCluster(
  [in] HCLUSTER hCluster
);

Parameters

[in] hCluster

Handle to the cluster to close.

Return value

This function always returns TRUE.

Remarks

Do not close a cluster handle if there are any object handles still in use that were obtained from the cluster handle. After a cluster handle has been closed, all handles obtained from that handle are invalid.

Examples

See Using Object Handles.

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