ClusterResourceTypeOpenEnum function (clusapi.h)

Article
02/22/2024

Opens an enumerator for iterating through a resource type's possible owner nodes or resources. The PCLUSAPI_CLUSTER_RESOURCE_TYPE_OPEN_ENUM type defines a pointer to this function.

Syntax

HRESTYPEENUM ClusterResourceTypeOpenEnum(
  [in] HCLUSTER hCluster,
  [in] LPCWSTR  lpszResourceTypeName,
  [in] DWORD    dwType
);

Parameters

[in] hCluster

Cluster handle.

[in] lpszResourceTypeName

A null-terminated Unicode string containing the name of the resource type.

[in] dwType

Bitmask describing the type of cluster objects to be enumerated. The following values of the CLUSTER_RESOURCE_TYPE_ENUM enumeration are valid.

CLUSTER_RESOURCE_TYPE_ENUM_NODES (1)

The object is a node that can be a possible owner of the resource type.

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES (2)

The object is a resource that is an instance of the resource type.

CLUSTER_RESOURCE_TYPE_ENUM_ALL (3)

Enumerate both nodes and resources.

Return value

If the operation succeeds, the function returns an enumeration handle which can be used in subsequent calls to ClusterResourceTypeEnum.

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

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