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

Статья
02/23/2024

Перечисляет возможные узлы или ресурсы владельца типа ресурса, возвращая имя одного узла или ресурса для каждого вызова. Тип PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM определяет указатель на эту функцию.

Синтаксис

DWORD ClusterResourceTypeEnum(
  [in]      HRESTYPEENUM hResTypeEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Параметры

[in] hResTypeEnum

Дескриптор перечисления типов ресурсов, возвращаемый из ClusterResourceTypeOpenum.

[in] dwIndex

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

[out] lpdwType

Тип объекта, возвращаемого ClusterResourceTypeEnum. Допустимы следующие значения перечисления CLUSTER_RESOURCE_TYPE_ENUM .

CLUSTER_RESOURCE_TYPE_ENUM_NODES (1)

Объект является узлом, который может быть возможным владельцем типа ресурса.

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES (2)

Объект является ресурсом, который является экземпляром типа ресурса.

[out] lpszName

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

[in, out] lpcchName

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

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

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

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

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

Примеры

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

Требования

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