Функция ClusterNodeEnum (clusapi.h)

Статья
08/22/2023

Перечисляет сетевые интерфейсы или группы , установленные на узле, возвращая имя каждого из них при каждом вызове. Тип 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: Значение CLUSTER_NODE_ENUM_GROUPS не поддерживается до Windows Server 2008 R2.

[out] lpszName

Указатель на строку Юникода, завершающуюся null, которая содержит имя возвращаемого объекта.

[in, out] lpcchName

Указатель на размер буфера lpszName в виде количества символов. На входных данных укажите максимальное количество символов, которые может содержать буфер, включая завершающее значение NULL. В выходных данных указывает количество символов в итоговом имени, за исключением завершающего значения NULL.

Возвращаемое значение

Функция возвращает одно из следующих значений.

Возвращаемый код/значение	Описание
ERROR_SUCCESS 0	Операция выполнена успешно.
ERROR_NO_MORE_ITEMS 259 (0x103)	Больше нет доступных данных. Это значение возвращается, если объектов запрошенного типа больше нет.
ERROR_MORE_DATA 234 (0xEA)	More data is available. Это значение возвращается, если буфер, на который указывает lpszName , недостаточно велик для хранения результата. Параметр lpcchName возвращает количество символов в результате, за исключением завершающего значения NULL.

Чтобы использовать ClusterNodeEnum, приложения сначала открывают дескриптор перечисления узлов, вызывая ClusterNodeOpenum с параметром dwType , равным CLUSTER_NODE_ENUM_NETINTERFACES. Дополнительные сведения см. в разделе Перечисление объектов.

Обратите внимание, что параметр lpcchName относится к количеству символов, а не к числу байтов, а возвращаемый размер не включает завершающее значение NULL в счетчике. Дополнительные сведения о размерах буферов см. в разделе Соглашения о размерах данных.

Примеры

См. раздел Перечисление объектов.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows Server 2008 Корпоративная, Windows Server 2008 Datacenter
Целевая платформа	Windows
Header	clusapi.h
Библиотека	ClusAPI.lib
DLL	ClusAPI.dll