GetClusterNetworkState

The GetClusterNetworkState function returns the current state of a network.

CLUSTER_NETWORK_STATE WINAPI GetClusterNetworkState(
  HNETWORK hNetwork
);

Parameters

hNetwork: [in] Handle to the network for which state information should be returned.

Return Values

If the operation was successful, GetClusterNetworkState returns the current state of the network, which is represented by one of the following values:

State	Description
ClusterNetworkStateDown	The network is not operational; none of the nodes on the network can communicate.
ClusterNetworkStatePartitioned	The network is operational, but two or more nodes on the network cannot communicate. Typically a path-specific problem has occurred.
ClusterNetworkStateUp	The network is operational; all of the nodes in the cluster can communicate.
ClusterNetworkStateUnavailable	State information for the network is unavailable. The network's Role property is set to ClusterNetworkRoleNone.

If the operation was unsuccessful, GetClusterNetworkState returns ClusterNetworkStateUnknown. For more detailed information about the error, call the Win32 function GetLastError.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.