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

Статья
03/08/2023

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

Синтаксис

CLUSTER_RESOURCE_STATE GetClusterResourceState(
  [in]                HRESOURCE hResource,
  [out, optional]     LPWSTR    lpszNodeName,
  [in, out, optional] LPDWORD   lpcchNodeName,
  [out, optional]     LPWSTR    lpszGroupName,
  [in, out, optional] LPDWORD   lpcchGroupName
);

Параметры

[in] hResource

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

[out, optional] lpszNodeName

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

[in, out, optional] lpcchNodeName

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

[out, optional] lpszGroupName

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

[in, out, optional] lpcchGroupName

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

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

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

Возвращаемый код или значение	Описание
ClusterResourceInitializing 1	Ресурс выполняет инициализацию.
ClusterResourceOnline 2	Ресурс работает и работает нормально.
ClusterResourceOffline 3	Ресурс не работает. Это значение будет возвращено, если ресурс сообщил о состоянии ClusterResourceOffline (3) или ClusterResourceCannotComeOnlineOnThisNode (127).
ClusterResourceFailed 4	Ресурс завершился сбоем. Это значение будет возвращено, если ресурс сообщил о состоянии ClusterResourceFailed (4) или ClusterResourceCannotComeOnlineOnAnyNode (126).
ClusterResourcePending 128	Ресурс находится в процессе подключения к сети или выхода в автономный режим.
ClusterResourceOnlinePending 129	Ресурс находится в процессе подключения к сети.
ClusterResourceOfflinePending 130	Ресурс находится в процессе выхода в автономный режим.
ClusterResourceStateUnknown -1	Операция не была успешной. Для получения дополнительных сведений об ошибке вызовите функцию GetLastError.

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

Примеры

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

Требования


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