SetClusterNetworkPriorityOrder function (clusapi.h)

Article
02/22/2024

[This function is available for use in the operating systems specified in the Requirements section. Support for this method was removed in Windows Server 2008 and this function does nothing and returns ERROR_CALL_NOT_IMPLEMENTED.]

Sets the priority order for the set of networks used for internal communication between cluster nodes. The PCLUSAPI_SET_CLUSTER_NETWORK_PRIORITY_ORDER type defines a pointer to this function.

Syntax

DWORD SetClusterNetworkPriorityOrder(
  [in] HCLUSTER    hCluster,
  [in] DWORD       NetworkCount,
  [in] HNETWORK [] NetworkList
);

Parameters

[in] hCluster

Handle to the cluster to be affected.

[in] NetworkCount

Number of items in the list specified by the NetworkList parameter.

[in] NetworkList

Prioritized array of handles to network objects. The first handle in the array has the highest priority. The list must contain only those networks that are used for internal communication between nodes in the cluster, and there can be no duplicates.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS (0).

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

Return code/value	Description
ERROR_INVALID_PARAMETER 87 (0x57)	There was a duplicate network in NetworkList.

Remarks

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 2003 Enterprise, Windows Server 2003 Datacenter
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll