ClusterResourceEnum 函数 (clusapi.h)

枚举 资源的 依赖资源、 节点或两者。 它返回每次调用的一个 群集对象 的名称。 PCLUSAPI_CLUSTER_RESOURCE_ENUM类型定义指向此函数的指针。

语法

DWORD ClusterResourceEnum(
  [in]      HRESENUM hResEnum,
  [in]      DWORD    dwIndex,
  [out]     LPDWORD  lpdwType,
  [out]     LPWSTR   lpszName,
  [in, out] LPDWORD  lpcchName
);

参数

[in] hResEnum

ClusterResourceOpenEnum 函数返回的资源枚举句柄。

[in] dwIndex

要返回的资源或节点对象的索引。 首次调用 ClusterResourceEnum 函数时,此参数应为零,然后针对后续调用递增。

[out] lpdwType

ClusterResourceEnum 返回的对象类型。

可能的值为下列 CLUSTER_RESOURCE_ENUM 枚举值之一:

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

对象是资源, hResEnum 是依赖于此对象的资源。

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

对象是依赖于 由 hResEnum 标识的资源的资源。

CLUSTER_RESOURCE_ENUM_NODES (4)

对象是可以托管 由 hResEnum 标识的资源的节点。

[out] lpszName

指向以 null 结尾的 Unicode 字符串的指针,该字符串包含返回的对象的名称。

[in, out] lpcchName

指向以字符计数形式表示的 lpszName 缓冲区大小的指针。 输入时,指定缓冲区可以容纳的最大字符数,包括终止 null 字符。 在输出时,指定结果名称中的字符数,不包括终止 null 字符。

返回值

函数返回以下值之一。

返回代码/值 说明
ERROR_SUCCESS
0
操作成功完成,或者 lpszName 参数为 NULL
ERROR_MORE_DATA
234 (0xEA)
lpszName 参数指向的缓冲区不够大,无法保存结果。 lpcchName 参数返回结果中的字符数,不包括终止 null 字符。
ERROR_NO_MORE_ITEMS
259 (0x103)
不再有要返回的对象。
系统错误代码
任何其他返回的错误代码都指示操作失败。

注解

请注意, lpcchName 指的是字符计数而不是字节计数,并且返回的大小不包括计数中的终止 null 字符。 有关调整缓冲区大小的详细信息,请参阅 数据大小约定

不要从任何资源 DLL 入口点函数调用 ClusterResourceEnum 。 可以从工作线程安全地调用 ClusterResourceEnum。 有关详细信息,请参阅 在资源 DLL 中对避免的函数调用

示例

请参阅 枚举对象

要求

要求
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
目标平台 Windows
标头 clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

另请参阅

群集资源管理功能

ClusterResourceCloseEnum

ClusterResourceOpenEnum