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

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

  • Статья

Перечисляет подразделы открытого ключа базы данных кластера .

Синтаксис

LONG ClusterRegEnumKey(
  [in]            HKEY      hKey,
  [in]            DWORD     dwIndex,
  [out]           LPWSTR    lpszName,
  [in, out]       LPDWORD   lpcchName,
  [out, optional] PFILETIME lpftLastWriteTime
);

Параметры

[in] hKey

Ключ HKEY , указывающий открытый в данный момент ключ.

[in] dwIndex

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

Так как подразделы не упорядочены, любой новый подраздел имеет произвольный индекс. Это означает, что ClusterRegEnumKey может возвращать подразделы в любом порядке.

[out] lpszName

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

[in, out] lpcchName

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

[out, optional] lpftLastWriteTime

Указатель на время последнего изменения перечисленного подраздела.

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

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

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

Комментарии

Функция ClusterRegEnumKey получает сведения об одном подразделе при каждом вызове.

Так как ClusterRegEnumKey перечисляет ключи из корня базы данных на узле, на котором выполняется приложение, если для hKey задано значение NULL, clusterRegEnumKey завершается сбоем, если узел не является частью кластера.

Требования

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

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

Функции доступа к реестру кластера

ClusterRegOpenKey