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

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

Синтаксис

DWORD ClusterResourceEnum(
  [in]      HRESENUM hResEnum,
  [in]      DWORD    dwIndex,
  [out]     LPDWORD  lpdwType,
  [out]     LPWSTR   lpszName,
  [in, out] LPDWORD  lpcchName
);

Параметры

[in] hResEnum

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

[in] dwIndex

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

[out] lpdwType

Тип объекта, возвращаемого ClusterResourceEnum.

Возможные значения являются одним из следующих CLUSTER_RESOURCE_ENUM значений перечисления:

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

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

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

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

CLUSTER_RESOURCE_ENUM_NODES (4)

Объект — это узел, на котором может размещаться ресурс, определенный hResEnum.

[out] lpszName

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

[in, out] lpcchName

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

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

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

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

Комментарии

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

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

Примеры

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

Требования

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

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

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

ClusterResourceCloseEnum

ClusterResourceOpenum