SetClusterGroupNodeList function (clusapi.h)

Sets the preferred node list for a group. The PCLUSAPI_SET_CLUSTER_GROUP_NODE_LIST type defines a pointer to this function.

Syntax

DWORD SetClusterGroupNodeList(
  [in] HGROUP   hGroup,
  [in] DWORD    NodeCount,
  [in] HNODE [] NodeList
);

Parameters

[in] hGroup

Handle to the group to be assigned the list of nodes.

[in] NodeCount

Count of nodes in the list identified by NodeList.

[in] NodeList

Array of handles to nodes, in order by preference, with the first node being the most preferred and the last node the least preferred. The number of nodes in the NodeList array is controlled by the NodeCount parameter.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

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

Remarks

Do not call SetClusterGroupNodeList 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

See also

OpenCluster

OpenClusterGroup

OpenClusterNode