Функция ClusterGroupEnum (clusapi.h)
Перечисляет ресурсы в группе или узлы , которые являются предпочтительными владельцами группы, возвращая имя ресурса или узла при каждом вызове. Тип PCLUSAPI_CLUSTER_GROUP_ENUM определяет указатель на эту функцию.
Синтаксис
DWORD ClusterGroupEnum(
[in] HGROUPENUM hGroupEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszResourceName,
[in, out] LPDWORD lpcchName
);
Параметры
[in] hGroupEnum
Дескриптор перечисления группы, возвращаемый функцией ClusterGroupOpenEnum .
[in] dwIndex
Индекс возвращаемого ресурса или узла. Этот параметр должен быть равен нулю для первого вызова ClusterGroupEnum , а затем увеличиваться для последующих вызовов.
[out] lpdwType
Указатель на тип объекта, возвращаемого ClusterGroupEnum. Ниже приведены допустимые значения перечисления CLUSTER_GROUP_ENUM .
CLUSTER_GROUP_ENUM_CONTAINS (1)
Объект является одним из ресурсов в группе.
CLUSTER_GROUP_ENUM_NODES (2)
Объект является одним из узлов в списке предпочтительных владельцев группы.
[out] lpszResourceName
Указатель на строку Юникода, завершающуюся null, которая содержит имя возвращаемого ресурса или узла.
[in, out] lpcchName
Указатель на размер буфера lpszResourceName в виде количества символов. На входных данных укажите максимальное количество символов, которые может содержать буфер, включая завершающее значение NULL. В выходных данных указывает количество символов в итоговом имени, за исключением завершающего значения NULL.
Возвращаемое значение
Функция может возвращать одно из следующих значений.
| Возвращаемый код/значение | Описание |
|---|---|
|
Операция выполнена успешно. |
|
More data is available. Это значение возвращается, если буфер, на который указывает lpszResourceName , недостаточно велик для хранения результата. Параметр lpcchName возвращает количество символов в результате, за исключением завершающего значения NULL. |
|
Больше нет доступных данных. Это значение возвращается, если нет дополнительных ресурсов или узлов, которые должны быть возвращены. |
Если операция не была успешной из-за проблемы, отличной от описанных с ERROR_NO_MORE_ITEMS или ERROR_MORE_DATA значений, ClusterGroupEnum возвращает код системной ошибки.
Комментарии
Обратите внимание, что lpcchName относится к количеству символов, а не к числу байтов, и что возвращаемый размер не включает завершающее значение NULL в счетчике. Дополнительные сведения о размерах буферов см. в разделе Соглашения о размерах данных.
Не вызывайте ClusterGroupEnum из какой-либо функции точки входа библиотеки DLL ресурсов. ClusterGroupEnum можно безопасно вызывать из рабочего потока. Дополнительные сведения см. в разделе Вызовы функций, которые следует избегать в библиотеках DLL ресурсов.
Примеры
См. раздел Перечисление объектов.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows Server 2008 Корпоративная, Windows Server 2008 Datacenter |
| Целевая платформа | Windows |
| Header | clusapi.h |
| Библиотека | ClusAPI.lib |
| DLL | ClusAPI.dll |