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

Статья
08/22/2023

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

Синтаксис

DWORD GetClusterNodeId(
  [in, optional] HNODE   hNode,
  [out]          LPWSTR  lpszNodeId,
  [in, out]      LPDWORD lpcchName
);

Параметры

[in, optional] hNode

Дескриптор узла с возвращаемым идентификатором или значением NULL. Если hNode имеет значение NULL, идентификатор узла, на котором выполняется приложение, возвращается в содержимом lpszNodeId.

[out] lpszNodeId

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

[in, out] lpcchName

На входных данных указатель на количество символов в буфере, на которые указывает параметр lpszNodeId , включая признак конца NULL . В выходных данных указатель на количество символов, хранящихся в буфере, за исключением признака конца NULL .

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

Эта функция возвращает код системной ошибки. Допустимы следующие значения:

Возвращаемый код или значение	Описание
ERROR_SUCCESS 0	Операция выполнена успешно.
ERROR_MORE_DATA 234 (0xEA)	More data is available. Это значение возвращается, если буфер, на который указывает lpszNodeId , недостаточно длинный для хранения необходимого количества символов. GetClusterNodeId задает содержимое lpcchName необходимой длины.

Если для hNode задано значение NULL , а вызывающий объект выполняется на активном узле кластера, функция GetClusterNodeId возвращает идентификатор узла, на котором выполняется приложение. Установка hNode значения NULL — это удобный способ определения идентификатора узла, на котором они выполняются. Вместо передачи null для параметра hNode можно использовать макрос GetCurrentClusterNodeId.

Идентификатор узла кластера — это уникальный идентификатор, который не изменяется даже при изменении имени узла.

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

Требования

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

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

GetCurrentClusterNodeId

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

OpenClusterNode

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