ClusterGroupEnumEx function (clusapi.h)

Article
02/22/2024

Retrieves an item in the enumeration.The PCLUSAPI_CLUSTER_GROUP_ENUM_EX type defines a pointer to this function.

Syntax

DWORD ClusterGroupEnumEx(
  [in]      HGROUPENUMEX             hGroupEnumEx,
  [in]      DWORD                    dwIndex,
  [in, out] PCLUSTER_GROUP_ENUM_ITEM pItem,
  [in, out] LPDWORD                  cbItem
);

Parameters

[in] hGroupEnumEx

The handle to the enumeration from which the item will be retrieved.

[in] dwIndex

The zero-based index of the item in the enumeration.

[in, out] pItem

A pointer to the buffer to be filled.

[in, out] cbItem

On input, the size of pItem.

On output, either the required size in bytes of the buffer if the buffer is too small, or the number of bytes written into the buffer.

Return value

Return code	Description
ERROR_NO_MORE_ITEMS	dwIndex is larger than the number of items in the enumeration.
ERROR_MORE_DATA	The buffer is too small.
ERROR_SUCCESS	The buffer was filled successfully.

Remarks

The ClusterGroupEnumEx function doesn't connect to the cluster, because the hGroupEnumEx already contains the enumeration data. The data is copied into the buffer but no data is retrieved from the cluster.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll

Share via