Share via

3.1.4.1.87 ApiSetNetworkPriorityOrder (Opnum 87)

  • Article

(Protocol Version 2) The ApiSetNetworkPriorityOrder method sets the list of internal networks to use, in decreasing order of priority, which a cluster node uses for cluster-related communication with other cluster nodes, as maintained by the server in the cluster internal network prioritization list.

The server fails this method using error ERROR_INVALID_PARAMETER if the count of networks specified by the NetworkCount parameter does not match the count of networks with a role of private or mixed.

The server MUST accept an ApiSetNetworkPriorityOrder request for processing only if it is in the read/write state, as specified in section 3.1.1.

 error_status_t ApiSetNetworkPriorityOrder(
   [in, range(0, 1000)] DWORD NetworkCount,
   [in, string, size_is(NetworkCount)] 
     LPWSTR NetworkIdList[*]
 );

NetworkCount: A count of pointers in the NetworkIdList parameter.

NetworkIdList: A pointer to an array of pointers that point to null-terminated Unicode strings that are the IDs, as specified in section 3.1.4.1.86, of internal networks.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x00000006

ERROR_INVALID_HANDLE

See the preceding text for when this error can occur.

0x00000057

ERROR_INVALID_PARAMETER

The count of networks specified by the NetworkCount parameter does not match the count of networks with a role of private or mixed.

For any other condition, the server MUST set Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.