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

Статья
08/22/2023

Перечисляет объекты кластера в сети, возвращая имя одного объекта при каждом вызове. Тип 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, которая содержит имя возвращаемого объекта.

[in, out] lpcchName

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

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

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

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

Функция ClusterNetworkEnum обычно используется для итерации по коллекции объектов одного или нескольких типов, принадлежащих сетевому объекту. Например, если приложению нужно перечислить все объекты сетевого интерфейса в сети, оно вызывает ClusterNetworkOpenEnum , чтобы открыть сетевой перечислитель, который может обрабатывать объекты сетевого интерфейса. Параметр dwType имеет значение CLUSTER_NETWORK_ENUM_NETINTERFACES , чтобы указать сетевые интерфейсы в качестве типа объекта для перечисления. С помощью дескриптора, возвращаемого ClusterNetworkOpenum , приложение вызывает ClusterNetworkEnum несколько раз, чтобы получить каждый из объектов . Параметр lpdwType указывает на тип извлекаемого объекта.

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

Примеры

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

Требования

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