ClusterNetworkOpenEnum

The ClusterNetworkOpenEnum function opens an enumerator for iterating through objects on a network.

HNETWORKENUM WINAPI ClusterNetworkOpenEnum(
  HNETWORK hNetwork,  
  DWORD dwType        
);
 

Parameters

hNetwork

[in] Handle to a network.

dwType

[in] Bitmask describing the type of objects to be enumerated. One or more of the following values are valid:

CLUSTER_NETWORK_ENUM_NETINTERFACES

Enumerate the network interface objects on the network.

CLUSTER_NETWORK_ENUM_ALL

Enumerate all objects on the network.

Return Values

NULL

The operation was unsuccessful. For more detailed information about the error, call the Win32 function GetLastError.

If the operation was successful, ClusterNetworkOpenEnum returns a handle to a network enumerator.

Remarks

Applications call the ClusterNetworkOpenEnum function to create a particular type of enumerator. ClusterNetworkOpenEnum can create enumerators for iterating through all of the objects on a network or only the network interface objects. ClusterNetworkOpenEnum returns a handle that can be passed to ClusterNetworkEnum to access each of the objects to be enumerated and to ClusterNetworkCloseEnum to release the enumerator.

QuickInfo

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