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

Статья
08/22/2023

Открывает перечислитель для перебора объектов кластера в кластере. Тип PCLUSAPI_CLUSTER_OPEN_ENUM определяет указатель на эту функцию.

Синтаксис

HCLUSENUM ClusterOpenEnum(
  [in] HCLUSTER hCluster,
  [in] DWORD    dwType
);

Параметры

[in] hCluster

Дескриптор кластера.

[in] dwType

Битовая маска, описывающая тип перечисляемых объектов. Одно или несколько из следующих значений перечисления CLUSTER_ENUM допустимы.

CLUSTER_ENUM_NODE (1 (0x1))

Перечисляет узлы в кластере.

CLUSTER_ENUM_RESTYPE (2 (0x2))

Перечисляет типы ресурсов в кластере.

CLUSTER_ENUM_RESOURCE (4 (0x4))

Перечисляет ресурсы в кластере.

CLUSTER_ENUM_GROUP (8 (0x8))

Перечисляет группы в кластере.

CLUSTER_ENUM_NETWORK (16 (0x10))

Перечисляет сети в кластере.

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

Перечисляет сетевые интерфейсы в кластере.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

Перечисляет общие тома кластера, используемые кластером.

Примечание В отличие от большинства других битов перечисления, это значение необходимо использовать отдельно. Не используйте оператор OR для объединения его с другими битами.

Windows Server 2008: Значение CLUSTER_ENUM_SHARED_VOLUME_RESOURCE не поддерживается до Windows Server 2008 R2.

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

Перечисляет сети, используемые кластером для внутреннего взаимодействия. Сети перечисляются в порядке наивысшего к самому низкому приоритету, установленному setClusterNetworkPriorityOrder.

CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE | CLUSTER_ENUM_RESTYPE | CLUSTER_ENUM_RESOURCE | CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NETWORK | CLUSTER_ENUM_NETINTERFACE))

Перечисляет все объекты кластера.

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

Если операция выполнена успешно, ClusterOpenEnum возвращает дескриптору кластера.

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

Приложения вызывают функцию ClusterOpenEnum , чтобы создать перечислитель определенного типа. ClusterOpenEnum может создавать перечислители для перебора групп, узлов, типов ресурсов, ресурсов или всех этих элементов. Например, приложение может вызвать ClusterOpenEnum , чтобы получить перечисление всех узлов и групп в кластере, указав CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NODE в параметре dwType . ClusterOpenUm возвращает дескриптор, который можно передать в ClusterEnum для доступа к каждой из групп кластера или узлов, а в ClusterCloseEnum — для освобождения перечислителя.

Примеры

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

Требования

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

См. также раздел

Функции управления кластерами

ClusterCloseEnum

ClusterEnum

SetClusterNetworkPriorityOrder

Поделиться через