Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 3.1 KB

nf-clusapi-destroycluster.md

File metadata and controls

101 lines (76 loc) · 3.1 KB
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.DestroyCluster
DestroyCluster function (clusapi.h)
Removes a cluster.
DestroyCluster
DestroyCluster function [Failover Cluster]
PCLUSAPI_DESTROY_CLUSTER
PCLUSAPI_DESTROY_CLUSTER function [Failover Cluster]
clusapi/DestroyCluster
clusapi/PCLUSAPI_DESTROY_CLUSTER
mscs.destroycluster
mscs\destroycluster.htm
MsCS
55e601de-b427-43cd-b7f8-6cc576077e59
12/05/2018
DestroyCluster, DestroyCluster function [Failover Cluster], PCLUSAPI_DESTROY_CLUSTER, PCLUSAPI_DESTROY_CLUSTER function [Failover Cluster], clusapi/DestroyCluster, clusapi/PCLUSAPI_DESTROY_CLUSTER, mscs.destroycluster
clusapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
ClusAPI.lib
ClusAPI.dll
Windows
19H1
DestroyCluster
clusapi/DestroyCluster
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
DestroyCluster

DestroyCluster function

-description

Removes a cluster. The PCLUSAPI_DESTROY_CLUSTER type defines a pointer to this function.

-parameters

-param hCluster [in]

Handle to a cluster, returned by the OpenCluster or CreateCluster function.

-param pfnProgressCallback [in, optional]

Address of callback function that matches the PCLUSTER_SETUP_PROGRESS_CALLBACK function pointer that will be called periodically to provide progress on the cluster destruction.

-param pvCallbackArg [in, optional]

Argument for the callback function.

-param fdeleteVirtualComputerObjects [in]

If TRUE, then delete the virtual computer objects associated with the cluster from the directory.

-returns

Returns ERROR_SUCCESS if the cluster was completely removed or a system error code for the last failed operation.

-remarks

It is possible for multiple steps to fail when removing a cluster with DestroyCluster, but only one error code can be returned. The cluster error log should be reviewed if an error is returned.

-see-also

Cluster Management Functions

CreateCluster

OpenCluster