ClusterNodeOpenEnum function (clusapi.h)
Opens an
enumerator for iterating through the network interfaces
or groups installed on a node. The PCLUSAPI_CLUSTER_NODE_OPEN_ENUM type defines a pointer to this function.
Syntax
HNODEENUM ClusterNodeOpenEnum(
[in] HNODE hNode,
[in] DWORD dwType
);
Parameters
[in] hNode
Handle to a node.
[in] dwType
Bitmask describing the type of objects to be enumerated. The following values of the CLUSTER_NODE_ENUM enumeration are valid.
CLUSTER_NODE_ENUM_NETINTERFACES (0x00000001)
Enumerate the network interface objects on the node.
CLUSTER_NODE_ENUM_GROUPS (0x00000002)
Enumerate the cluster groups on the node.
CLUSTER_NODE_ENUM_ALL ((CLUSTER_NODE_ENUM_NETINTERFACES | CLUSTER_NODE_ENUM_GROUPS))
Enumerate the network interfaces objects and cluster groups on the node.
Windows Server 2008: The CLUSTER_NODE_ENUM_GROUPS value is not supported before Windows Server 2008 R2.
Return value
If the operation succeeds, ClusterNodeOpenEnum returns a handle to a node enumerator.
If the operation fails, the function returns NULL. For more information about the error, call the GetLastError function.
Remarks
The ClusterNodeOpenEnum function returns a handle that can be passed to ClusterNodeEnum to access each of the objects to be enumerated and to ClusterNodeCloseEnum 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 |