ClusterResourceOpenEnum function (clusapi.h)

Article
10/13/2021

Opens an enumerator for iterating through a resource's dependencies and nodes. The PCLUSAPI_CLUSTER_RESOURCE_OPEN_ENUM type defines a pointer to this function.

Syntax

HRESENUM ClusterResourceOpenEnum(
  [in] HRESOURCE hResource,
  [in] DWORD     dwType
);

Parameters

[in] hResource

A handle to a resource.

[in] dwType

A bitmask that describes the type of cluster objects to be enumerated.

The following values of the CLUSTER_RESOURCE_ENUM enumeration are valid.

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

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

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

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

CLUSTER_RESOURCE_ENUM_NODES (4)

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

Return value

If the operation succeeds, the function returns an enumeration handle.

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

Remarks

Do not call ClusterResourceOpenEnum from any resource DLL entry point function. ClusterResourceOpenEnum can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

Examples

See Enumerating Objects.

Requirements

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