ClusterNetworkOpenEnum function (clusapi.h)
Opens an enumerator for iterating through objects on a network. The PCLUSAPI_CLUSTER_NETWORK_OPEN_ENUM type defines a pointer to this function.
Syntax
HNETWORKENUM ClusterNetworkOpenEnum(
[in] HNETWORK hNetwork,
[in] DWORD dwType
);
Parameters
[in] hNetwork
A handle to a network.
[in] dwType
A bitmask that describes the type of objects to be enumerated. One or more of the following values CLUSTER_NETWORK_ENUM enumeration are valid.
CLUSTER_NETWORK_ENUM_NETINTERFACES (1)
Enumerates the network interface objects on the network.
Return value
If the operation was successful, ClusterNetworkOpenEnum returns a handle to a network enumerator.
If the operation fails, the function returns NULL. For more information about the error, call the function GetLastError.
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.
Examples
See Enumerating Objects.
Requirements
| Requirement | Value |
|---|---|
| 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 |