GetClusterNetworkState function

Returns the current state of a network. The PCLUSAPI_GET_CLUSTER_NETWORK_STATE type defines a pointer to this function.

Syntax

CLUSTER_NETWORK_STATE GetClusterNetworkState(
  HNETWORK hNetwork
);

Parameters

hNetwork

Handle to the network for which state information should be returned.

Return value

GetClusterNetworkState returns the current state of the network, which is represented by one of the following values enumerated by the CLUSTER_NETWORK_STATE enumeration.

Return code/value Description
ClusterNetworkUnavailable
0
All of the network interfaces on the network are unavailable, which means that the nodes that own the network interfaces are down.
ClusterNetworkDown
1
The network is not operational; none of the nodes on the network can communicate.
ClusterNetworkPartitioned
2
The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred.
ClusterNetworkUp
3
The network is operational; all of the nodes in the cluster can communicate.
ClusterNetworkStateUnknown
-1
The operation was not successful. For more information about the error, call the function GetLastError.

Requirements

   
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

CLUSTER_NETWORK_STATE

OpenClusterNetwork