ClusterUpgradeFunctionalLevel function (clusapi.h)

Initiates a rolling upgrade of the operating system on a cluster. PCLUSAPI_CLUSTER_UPGRADE defines a pointer to this function.


DWORD ClusterUpgradeFunctionalLevel(
  [in]           HCLUSTER                           hCluster,
  [in]           BOOL                               perform,
  [in, optional] PCLUSTER_UPGRADE_PROGRESS_CALLBACK pfnProgressCallback,
  [in, optional] PVOID                              pvCallbackArg


[in] hCluster

A handle to the cluster to upgrade.

[in] perform

True to initiate the rolling upgrade; otherwise false.

[in, optional] pfnProgressCallback

A pointer to the ClusterUpgradeProgressCallback callback function that retrieves the status of the rolling upgrade.

[in, optional] pvCallbackArg

A pointer to the arguments for pfnProgressCallback.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS. If the operation fails, the function returns a system error code.


Minimum supported client None supported
Minimum supported server Windows Server 2016
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also


Failover Cluster Management Functions