ClusterResourceEnum

The ClusterResourceEnum function enumerates a resource's dependent resources and/or nodes, returning the name of one object with each call.

DWORD WINAPI ClusterResourceEnum(
  HRESENUM hResEnum, 
  DWORD dwIndex,     
  LPDWORD lpdwType,  
  LPWSTR lpszName,   
  LPDWORD lpcchName  
);
 

Parameters

hResEnum

[in] Handle to a resource enumerator object — a handle returned from ClusterResourceOpenEnum.

dwIndex

[in] Index of the resource or node object to return. This parameter should be zero for the first call to the ClusterResourceEnum function and then incremented for subsequent calls.

lpdwType

[out] Type of object returned by ClusterResourceEnum. Valid types are:

CLUSTER_RESOURCE_ENUM_DEPENDS

The object is a resource that the resource identified by hResource directly depends on.

CLUSTER_RESOURCE_ENUM_PROVIDES

The object is a resource that depends on the resource identified by hResource.

CLUSTER_RESOURCE_ENUM_NODES

The object is a node that can host the resource identified by hResource.

lpszName

[out] Pointer to the name of the returned object, including the terminating NULL character.

lpcchName

[in, out] Pointer to the count of characters in the buffer pointed to by the lpszName parameter. This size should include the terminating NULL character. On output, pointer to the count of characters stored in the buffer, excluding the terminating NULL character.

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_NO_MORE_ITEMS

There are no more objects to be returned.

If the operation was unsuccessful due to a problem other than not having any more objects to return, ClusterResourceEnum returns a Win32 error value.

QuickInfo

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