ClusterResourceEnumEx function (clusapi.h)

Enumerates a resource and then returns a pointer to the current dependent resource or node.

Syntax

DWORD ClusterResourceEnumEx(
  [in]      HRESENUMEX                  hResourceEnumEx,
  [in]      DWORD                       dwIndex,
  [in, out] PCLUSTER_RESOURCE_ENUM_ITEM pItem,
  [in, out] LPDWORD                     cbItem
);

Parameters

[in] hResourceEnumEx

A handle to a resource enumeration that is returned from the ClusterResourceOpenEnumEx function.

[in] dwIndex

The index of the resource or node object to return. This parameter should be zero for the first call to the ClusterResourceEnumEx function and then be
incremented for subsequent calls.

[in, out] pItem

A pointer that receives the returned object.

[in, out] cbItem

On input, the size of the pItem parameter.

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

The function returns one of the following values.

Return code/value	Description
ERROR_SUCCESS 0	The operation finished successfully, or the lpszName parameter is NULL.
ERROR_MORE_DATA 234 (0xEA)	The buffer to which the lpszName parameter points is not big enough to hold the result. The lpcchName parameter returns the number of characters in the result, excluding the terminating null character.
ERROR_NO_MORE_ITEMS 259 (0x103)	There are no more objects to be returned.
System error code	Any other returned error code indicates that the operation failed.

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

See also

ClusterResourceOpenEnumEx

Failover Cluster Resource Management Functions