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

Статья
08/22/2023

Возвращает текущее состояние группы. Тип PCLUSAPI_GET_CLUSTER_GROUP_STATE определяет указатель на эту функцию.

Синтаксис

CLUSTER_GROUP_STATE GetClusterGroupState(
  [in]                HGROUP  hGroup,
  [out, optional]     LPWSTR  lpszNodeName,
  [in, out, optional] LPDWORD lpcchNodeName
);

Параметры

[in] hGroup

Дескриптор для группы, для которой должны быть возвращены сведения о состоянии.

[out, optional] lpszNodeName

Указатель на строку Юникода, завершающуюся значением NULL, которая содержит имя узла, которому в данный момент принадлежит группа.

[in, out, optional] lpcchNodeName

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

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

GetClusterGroupState возвращает текущее состояние группы, представленное одним из следующих значений.

Возвращаемый код или значение	Описание
ClusterGroupStateUnknown -1	Операция не была успешной. Для получения дополнительных сведений об ошибке вызовите функцию GetLastError.
ClusterGroupOnline 0	Все ресурсы в группе находятся в сети.
ClusterGroupOffline 1	Все ресурсы в группе находятся в автономном режиме или в ней нет ресурсов.
ClusterGroupFailed 2	По крайней мере один ресурс в группе завершился сбоем (задайте состояние ClusterResourceFailed из перечисления CLUSTER_RESOURCE_STATE ).
ClusterGroupPartialOnline 3	По меньшей мере один ресурс в группе находится в оперативном состоянии. Ресурсы не находятся в состоянии ожидания или сбоя.
ClusterGroupPending 4	По меньшей мере один ресурс в группе находится в состоянии ожидания. Ресурсы со сбоем отсутствуют.

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

Не вызывайте GetClusterGroupState из любой функции точки входа DLL ресурсов. GetClusterGroupState можно безопасно вызывать из рабочего потока. Дополнительные сведения см. в разделе Вызовы функций, которые следует избегать в библиотеках DLL ресурсов.

Требования

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

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

CLUSTER_GROUP_STATE

CLUSTER_RESOURCE_STATE

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

OpenClusterGroup

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