OnlineClusterGroup function (clusapi.h)

Article
07/27/2022

Brings a group online. The PCLUSAPI_ONLINE_CLUSTER_GROUP type defines a pointer to this function.

Syntax

DWORD OnlineClusterGroup(
  [in]           HGROUP hGroup,
  [in, optional] HNODE  hDestinationNode
);

Parameters

[in] hGroup

Handle to the group to be brought online.

[in, optional] hDestinationNode

Handle to the node where the group identified by hGroup should be brought online or NULL.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following are possible error codes.

Return code	Description
ERROR_HOST_NODE_NOT_AVAILABLE	A suitable host node was not available.
ERROR_IO_PENDING	The operation is in progress.

Remarks

If the group cannot be brought online on the node identified by the hDestinationNode parameter, the OnlineClusterGroup function fails.

If the hDestinationNode parameter is set to NULL, OnlineClusterGroup brings the group online on the current node.

Do not call OnlineClusterGroup from a resource DLL. For more information, see Function Calls to Avoid in Resource DLLs.

Do not pass LPC and RPC handles to the same function call. Otherwise, the call will raise an RPC exception and can have additional destructive effects. For information on how LPC and RPC handles are created, see Using Object Handles and OpenCluster.

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