nf-clusapi-clusterresourcetypeenum.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:clusapi.ClusterResourceTypeEnum	ClusterResourceTypeEnum function (clusapi.h)	Enumerates a resource type's possible owner nodes or resources.	CLUSTER_RESOURCE_TYPE_ENUM_NODES CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES ClusterResourceTypeEnum ClusterResourceTypeEnum function [Failover Cluster] PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM function [Failover Cluster] _wolf_clusterresourcetypeenum clusapi/ClusterResourceTypeEnum clusapi/PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM mscs.clusterresourcetypeenum	mscs\clusterresourcetypeenum.htm	MsCS	956300f4-a7e8-4a8b-ab7e-e8fc3a37bf21	12/05/2018	CLUSTER_RESOURCE_TYPE_ENUM_NODES, CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES, ClusterResourceTypeEnum, ClusterResourceTypeEnum function [Failover Cluster], PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM, PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM function [Failover Cluster], _wolf_clusterresourcetypeenum, clusapi/ClusterResourceTypeEnum, clusapi/PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM, mscs.clusterresourcetypeenum	clusapi.h		Windows	None supported	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter										ClusAPI.lib	ClusAPI.dll		Windows			19H1	ClusterResourceTypeEnum clusapi/ClusterResourceTypeEnum	c++	APIRef kbSyntax	DllExport	ClusAPI.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-0.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-1.dll Ext-MS-Win-Cluster-ClusAPI-l1-1-2.dll	ClusterResourceTypeEnum

ClusterResourceTypeEnum function

-description

Enumerates a resource type's possible owner nodes or resources, returning the name of one node or resource per call. The PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM type defines a pointer to this function.

-parameters

-param hResTypeEnum [in]

Resource type enumeration handle returned from ClusterResourceTypeOpenEnum.

-param dwIndex [in]

Index of the resource or node object to return. This parameter should be zero for the first call to ClusterResourceTypeEnum and then incremented for subsequent calls.

-param lpdwType [out]

Type of object returned by ClusterResourceTypeEnum. 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.

-param lpszName [out]

Pointer to a null-terminated Unicode string containing the name of the returned object.

-param lpcchName [in, out]

Pointer to the size of the lpszName buffer as a count of characters. On input, specify the maximum number of characters the buffer can hold, including the terminating NULL. On output, specifies the number of characters in the resulting name, excluding the terminating NULL.

-returns

The function returns one of the following values.

Return code/value	Description
ERROR_SUCCESS 0	The operation was successful.
ERROR_NO_MORE_ITEMS 259	There are no more objects to be returned.
ERROR_MORE_DATA 234	The buffer pointed to by lpszName is not big enough to hold the result. The lpcchName parameter returns the number of characters in the result, excluding the terminating NULL.
System error code	The operation failed.

-remarks

Note that lpcchName refers to a count of characters and not a count of bytes, and that the returned size does not include the terminating NULL in the count. For more information on sizing buffers, see Data Size Conventions.

Examples

See Enumerating Objects.

-see-also

CLUSTER_RESOURCE_TYPE_ENUM

ClusterResourceTypeCloseEnum

ClusterResourceTypeOpenEnum

Resource Type Management Functions