DestroyCluster function

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

Syntax


DWORD DestroyCluster(
  _In_      HCLUSTER hCluster,
  _In_opt_  PCLUSTER_SETUP_PROGRESS_CALLBACK pfnProgressCallback,
  _In_opt_  PVOID pvCallbackArg,
  _In_      BOOL fdeleteVirtualComputerObjects
);

typedef DWORD (WINAPI *PCLUSAPI_DESTROY_CLUSTER)(
    _In_      HCLUSTER hCluster,
    _In_opt_  PCLUSTER_SETUP_PROGRESS_CALLBACK pfnProgressCallback,
    _In_opt_  PVOID pvCallbackArg,
    _In_      BOOL fdeleteVirtualComputerObjects
);

Parameters

hCluster [in]

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

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.

pvCallbackArg [in, optional]

Argument for the callback function.

fdeleteVirtualComputerObjects [in]

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

Return value

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.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Datacenter, Windows Server 2008 Enterprise

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Cluster Management Functions
CreateCluster
OpenCluster

 

 

Show:
© 2014 Microsoft