Edit

Share via

ClusterGroupSetEnum function (clusapi.h)

  • Article

Returns the next enumerable object.

Syntax

DWORD ClusterGroupSetEnum(
  [in]      HGROUPSETENUM hGroupSetEnum,
  [in]      DWORD         dwIndex,
  [out]     LPWSTR        lpszName,
  [in, out] LPDWORD       lpcchName
);

Parameters

[in] hGroupSetEnum

A handle to an open cluster node enumeration returned by ClusterNodeOpenEnum

[in] dwIndex

The index to enumerate, zero for the first call to this function and then incremented for subsequent calls.

[out] lpszName

Points to a buffer that receives the name of the object, including the terminating null character.

[in, out] lpcchName

Points to a variable that specifies the size, in characters, of the buffer pointed to by the lpszName parameter. This size should include the terminating null character. When the function returns, the variable contains the number of characters stored in the buffer, not including the terminating null character.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code.

Requirements

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