ClusterNetworkEnum 函数 (clusapi.h)

枚举网络上群集对象,每次调用时返回一个对象的名称。 PCLUSAPI_CLUSTER_NETWORK_ENUM类型定义指向此函数的指针。

语法

DWORD ClusterNetworkEnum(
  [in]      HNETWORKENUM hNetworkEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

参数

[in] hNetworkEnum

最初由 ClusterNetworkOpenEnum 函数返回的现有枚举对象的句柄。

[in] dwIndex

用于标识要枚举的下一个条目的索引。 对于第一次调用 ClusterNetworkEnum ,此参数应为零,然后为后续调用递增。

[out] lpdwType

指向返回的对象类型的指针。 每次调用都会返回 CLUSTER_NETWORK_ENUM 枚举的以下值。

CLUSTER_NETWORK_ENUM_NETINTERFACES (1)

对象是 网络接口

[out] lpszName

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

[in, out] lpcchName

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

返回值

函数返回以下值之一。

返回代码/值 说明
ERROR_SUCCESS
0
操作已成功完成。
ERROR_MORE_DATA
234 (0xEA)
更多数据可用。 如果 lpszName 指向的缓冲区不够大,无法保存结果,则返回此值。 lpcchName 参数返回结果中的字符数,不包括终止 NULL
ERROR_NO_MORE_ITEMS
259 (0x103)
没有更多可用数据。 如果没有更多要返回的请求类型的对象,则返回此值。

注解

ClusterNetworkEnum 函数通常用于循环访问属于网络对象的一个或多个类型的对象集合。 例如,如果应用程序想要枚举网络上的所有 网络接口 对象,它将调用 ClusterNetworkOpenEnum 以打开可以处理网络接口对象的网络枚举器。 dwType 参数设置为 CLUSTER_NETWORK_ENUM_NETINTERFACES 以将网络接口指定为要枚举的对象类型。 使用 ClusterNetworkOpenEnum 返回的句柄,应用程序重复调用 ClusterNetworkEnum 以检索每个对象。 lpdwType 参数指向检索到的对象类型。

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

示例

请参阅 枚举对象

要求

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

另请参阅

CLUSTER_NETWORK_ENUM

群集网络管理功能

ClusterNetworkCloseEnum

ClusterNetworkOpenEnum