ClusterOpenEnum

The ClusterOpenEnum function opens an enumerator for iterating through objects in a cluster.

HCLUSENUM WINAPI ClusterOpenEnum(
  HCLUSTER hCluster,  
  DWORD dwType        
);
 

Parameters

hCluster

[in] Handle to a cluster.

dwType

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

CLUSTER_ENUM_GROUP

Enumerate the groups in the cluster.

CLUSTER_ENUM_NODE

Enumerate the nodes in the cluster.

CLUSTER_ENUM_RESTYPE

Enumerate the resource types in the cluster.

CLUSTER_ENUM_RESOURCE

Enumerate the resources in the cluster.

Return Values

NULL

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

If the operation was successful, ClusterOpenEnum returns a handle to a cluster enumerator.

Remarks

Applications call the ClusterOpenEnum function to create a particular type of enumerator. ClusterOpenEnum can create enumerators for iterating through groups, nodes, resource types, and/or resources. For example, an application can call ClusterOpenEnum to get an enumeration of all of the nodes and groups in a cluster by specifying CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NODE in the dwType parameter. ClusterOpenEnum returns a handle that can be passed to ClusterEnum to access each of the cluster groups or nodes and to ClusterCloseEnum to release the enumerator.

QuickInfo

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