GetClusterNetInterfaceState

The GetClusterNetInterfaceState function returns the current state of a network interface.

CLUSTER_NETINTERFACE_STATE WINAPI GetClusterNetInterfaceState(
  HNETINTERFACE hNetInterface
);

Parameters

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

Return Values

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

State	Description
ClusterNetInterfaceFailed	The network interface is not operational; typically a hardware failure has occurred.
ClusterNetInterfaceUnreachable	None of the active nodes in the cluster can access the network interface.
ClusterNetworkUp	The network interface is operational.
ClusterNetworkUnavailable	State information for the network interface is unavailable.

If the operation was unsuccessful, GetClusterNetInterfaceState returns ClusterNetInterfaceStateUnknown. 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.