Edit

ClusterOpenEnumEx function (clusapi.h)

  • Article

Opens a handle to a cluster in order to iterate through its objects.

Syntax

HCLUSENUMEX ClusterOpenEnumEx(
  [in]                          HCLUSTER hCluster,
  [in]                          DWORD    dwType,
  [in, optional] [in, optional] PVOID    pOptions
);

Parameters

[in] hCluster

The handle to the cluster.

[in] dwType

A bitmask that describes the type of objects to be enumerated. This must be one or more of the CLUSTER_ENUM enumeration values.

[in, optional] [in, optional] pOptions

Options.

Return value

If the operation succeeds, returns a handle to a cluster enumerator.

If the operation fails, the function returns NULL. For more information about the error, call the function GetLastError.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also

CLUSTER_ENUM

Failover Cluster Management Function