EvictClusterNodeEx function (clusapi.h)

  • Article

Evicts a node from the cluster and initiates cleanup operations on the node. The PCLUSAPI_EVICT_CLUSTER_NODE_EX type defines a pointer to this function.

Syntax

DWORD EvictClusterNodeEx(
  [in]  HNODE   hNode,
  [in]  DWORD   dwTimeOut,
  [out] HRESULT *phrCleanupStatus
);

Parameters

[in] hNode

Handle to the node to remove from the cluster.

[in] dwTimeOut

Specifies the number of milliseconds for the function to wait for cleanup operations to occur. The function will return when the cleanup is complete or when the specified time elapses, whichever is sooner.

[out] phrCleanupStatus

Pointer to an HRESULT that describes the results of the cleanup operation.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code, including the following value.

Return code Description
ERROR_CLUSTER_EVICT_WITHOUT_CLEANUP
 The node was evicted but the cleanup operation returned a value other than S_OK.

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

See also

EvictClusterNode

OpenClusterNode