ClusterNodeEnum 函数 (clusapi.h)
枚举节点上安装的网络接口或组,每次调用时返回每个接口或组的名称。 PCLUSAPI_CLUSTER_NODE_ENUM类型定义指向此函数的指针。
语法
DWORD ClusterNodeEnum(
[in] HNODEENUM hNodeEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
参数
[in] hNodeEnum
ClusterNodeOpenEnum 函数最初返回的现有枚举对象的句柄。
[in] dwIndex
用于标识要枚举的下一个条目的索引。 对于第一次调用 ClusterNodeEnum ,此参数应为零,然后针对后续调用递增。
[out] lpdwType
指向返回的对象类型的指针。 每次调用时都会返回 CLUSTER_NODE_ENUM 枚举的以下值。
CLUSTER_NODE_ENUM_NETINTERFACES (1)
对象是网络接口。
CLUSTER_NODE_ENUM_GROUPS (0x00000002)
对象是群集组。
Windows Server 2008: 在 Windows Server 2008 R2 之前不支持 CLUSTER_NODE_ENUM_GROUPS 值。
[out] lpszName
指向以 null 结尾的 Unicode 字符串的指针,该字符串包含返回的对象的名称。
[in, out] lpcchName
指向 lpszName 缓冲区大小(字符计数)的指针。 在输入时,指定缓冲区可以容纳的最大字符数,包括终止 NULL。 在输出时,指定结果名称中的字符数,不包括终止 NULL。
返回值
函数返回以下值之一。
返回代码/值 | 说明 |
---|---|
|
操作已成功完成。 |
|
没有更多可用数据。 如果没有更多要返回的请求类型的对象,则返回此值。 |
|
更多数据可用。 如果 lpszName 指向的缓冲区不够大,无法保存结果,则返回此值。 lpcchName 参数返回结果中的字符数,不包括终止 NULL。 |
注解
若要使用 ClusterNodeEnum,应用程序首先通过调用 ClusterNodeOpenEnum 来打开节点枚举句柄,并将 dwType 参数设置为 CLUSTER_NODE_ENUM_NETINTERFACES。 有关详细信息,请参阅 枚举对象。
请注意, lpcchName 参数引用字符计数而不是字节计数,并且返回的大小不包括计数中的终止 NULL 。 有关调整缓冲区大小的详细信息,请参阅 数据大小约定。
示例
请参阅 枚举对象。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 无受支持的版本 |
最低受支持的服务器 | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
目标平台 | Windows |
标头 | clusapi.h |
Library | ClusAPI.lib |
DLL | ClusAPI.dll |