Skip to content

Latest commit

 

History

History
121 lines (93 loc) · 3.76 KB

nf-clusapi-onlineclustergroup.md

File metadata and controls

121 lines (93 loc) · 3.76 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.OnlineClusterGroup
OnlineClusterGroup function (clusapi.h)
Brings a group online. (OnlineClusterGroup)
OnlineClusterGroup
OnlineClusterGroup function [Failover Cluster]
PCLUSAPI_ONLINE_CLUSTER_GROUP
PCLUSAPI_ONLINE_CLUSTER_GROUP function [Failover Cluster]
_wolf_onlineclustergroup
clusapi/OnlineClusterGroup
clusapi/PCLUSAPI_ONLINE_CLUSTER_GROUP
mscs.onlineclustergroup
mscs\onlineclustergroup.htm
MsCS
33b4f435-f394-41fc-846f-8e9206c76aa1
12/05/2018
OnlineClusterGroup, OnlineClusterGroup function [Failover Cluster], PCLUSAPI_ONLINE_CLUSTER_GROUP, PCLUSAPI_ONLINE_CLUSTER_GROUP function [Failover Cluster], _wolf_onlineclustergroup, clusapi/OnlineClusterGroup, clusapi/PCLUSAPI_ONLINE_CLUSTER_GROUP, mscs.onlineclustergroup
clusapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ClusAPI.lib
ClusAPI.dll
Windows
19H1
OnlineClusterGroup
clusapi/OnlineClusterGroup
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
OnlineClusterGroup

OnlineClusterGroup function

-description

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

-parameters

-param hGroup [in]

Handle to the group to be brought online.

-param hDestinationNode [in, optional]

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

-returns

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.

-see-also

OfflineClusterGroup

OpenCluster

OpenClusterGroup