Skip to content

Latest commit

 

History

History
162 lines (110 loc) · 5.08 KB

nf-resapi-resutilenumresourcesex.md

File metadata and controls

162 lines (110 loc) · 5.08 KB
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:resapi.ResUtilEnumResourcesEx
ResUtilEnumResourcesEx function (resapi.h)
Enumerates all of the resources in a specified cluster and initiates a user-defined operation for each resource. The PRESUTIL_ENUM_RESOURCES_EX type defines a pointer to this function.
PRESUTIL_ENUM_RESOURCES_EX
PRESUTIL_ENUM_RESOURCES_EX function [Failover Cluster]
ResUtilEnumResourcesEx
ResUtilEnumResourcesEx function [Failover Cluster]
_wolf_resutilenumresourcesex
mscs.resutilenumresourcesex
resapi/PRESUTIL_ENUM_RESOURCES_EX
resapi/ResUtilEnumResourcesEx
mscs\resutilenumresourcesex.htm
MsCS
e9f2e203-bbfb-4b27-b9ca-ab6b6ea1e60f
12/05/2018
PRESUTIL_ENUM_RESOURCES_EX, PRESUTIL_ENUM_RESOURCES_EX function [Failover Cluster], ResUtilEnumResourcesEx, ResUtilEnumResourcesEx function [Failover Cluster], _wolf_resutilenumresourcesex, mscs.resutilenumresourcesex, resapi/PRESUTIL_ENUM_RESOURCES_EX, resapi/ResUtilEnumResourcesEx
resapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
ResUtils.lib
ResUtils.dll
Windows
19H1
ResUtilEnumResourcesEx
resapi/ResUtilEnumResourcesEx
c++
APIRef
kbSyntax
DllExport
ResUtils.dll
Ext-MS-Win-Cluster-Resutils-L1-1-1.dll
ResUtilEnumResourcesEx

ResUtilEnumResourcesEx function

-description

Enumerates all of the resources in a specified cluster and initiates a user-defined operation for each resource. The PRESUTIL_ENUM_RESOURCES_EX type defines a pointer to this function.

-parameters

-param hCluster [in]

A handle to the cluster that contains the resources to enumerate.

-param hSelf [in, optional]

An optional handle to a cluster resource. The callback function is not invoked for a resource that is identified by hSelf.

-param lpszResTypeName [in]

An optional pointer to a name of a resource type that narrows the scope of resources to enumerate. If lpszResTypeName is specified, only resources of the specified type are enumerated.

-param pResCallBack [in]

A pointer to a user-defined function that is called for each enumerated resource. This function must conform to the definition of the ResourceCallbackEx callback function. Note that parameter names are not part of the definition; they have been added here for clarity.

DWORD (*LPRESOURCE_CALLBACK_EX)( 
  HCLUSTER hCluster,
  HRESOURCE hSelf, 
  HRESOURCE hEnum, 
  PVOID pParameter 
);

hCluster

The hCluster parameter that is passed to ResUtilEnumResourcesEx.

hSelf

The hSelf parameter that is passed to ResUtilEnumResourcesEx. Note that the callback function is never called when hSelf and hEnum refer to the same resource.

hEnum

A handle to the resource that currently is being enumerated. ResUtilEnumResourcesEx opens and closes this handle automatically.

pParameter

A generic buffer that enables you to pass any kind of data to the callback function.

-param pParameter [in]

A generic buffer that enables you to pass any kind of data to the callback function. ResUtilEnumResourcesEx does not use this parameter at all; it merely passes the pointer to the callback function. Whether you can pass NULL for the parameter depends on how the callback function is implemented.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function immediately halts the enumeration and returns the value that is returned by the callback function.

-remarks

ResUtilEnumResourcesEx is a convenient and easy-to-use alternative to the ClusterResourceEnum function.

Examples

See the example for ResUtilEnumResources.

-see-also

ClusterResourceEnum

ResUtilEnumResources

ResourceCallbackEx