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

Статья
02/23/2024

Добавляет команду в пакет, который будет выполняться в разделе реестра кластера. Дополнительные вызовы функции приведут к получению дополнительных команд, добавленных в пакет. Пакет был создан функцией ClusterRegCreateBatch и будет либо выполняться, либо игнорироваться функцией ClusterRegCloseBatch .

Синтаксис

LONG ClusterRegBatchAddCommand(
  [in]           HREGBATCH           hRegBatch,
  [in]           CLUSTER_REG_COMMAND dwCommand,
  [in, optional] LPCWSTR             wzName,
  [in]           DWORD               dwOptions,
  [in, optional] VOID const          *lpData,
  [in]           DWORD               cbData
);

Параметры

[in] hRegBatch

Дескриптор пакета, в который будет добавлена команда.

[in] dwCommand

Команда, поддерживаемая этим API, взятая из перечисления CLUSTER_REG_COMMAND . Ниже приведены возможные команды.

CLUSREG_SET_VALUE (1)

Задает значение относительно последнего выполненного CLUSREG_CREATE_KEY команды или (если не указано) относительно ключа, переданного в функцию ClusterRegCreateBatch .

CLUSREG_CREATE_KEY (2)

Создает указанный раздел реестра кластера, если он не существует, или открывает существующий.

CLUSREG_DELETE_KEY (3)

Удаляет ключ со всеми значениями и вложенными подразделами. Никакие команды, работающие со значениями, не могут следовать CLUSREG_DELETE_KEY до добавления CLUSREG_CREATE_KEY .

CLUSREG_DELETE_VALUE (4)

Удаляет значение, относительно последнего выполненного CLUSREG_CREATE_KEY команды или (если оно не указано) относительно ключа, переданного в функцию ClusterRegCreateBatch .

[in, optional] wzName

Имя значения или ключа относительно команды, выданной параметром dwCommand .

[in] dwOptions

Если dwCommand принимает команду CLUSREG_SET_VALUE , то этот параметр принимает один из стандартных типов значений реестра. В противном случае параметру dwCommand присваивается значение 0.

[in, optional] lpData

Указатель на данные относительно команды, выданной dwCommand. Значение этого параметра равно NULL для всех команд , кроме команды CLUSREG_SET_VALUE .

[in] cbData

Число (в байтах) данных относительно команды, выданной dwCommand. Значение этого параметра равно 0 для всех команд , кроме команды CLUSREG_SET_VALUE .

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

Функция возвращает один из следующих кодов системных ошибок.

Возвращаемый код или значение	Описание
ERROR_SUCCESS 0	Операция выполнена успешно.
ERROR_INVALID_FUNCTION 1	Неверная функция. Это значение возвращается, если dwCommand принимает какие-либо команды, отличные от команд, описанных в предыдущем разделе.
ERROR_INVALID_HANDLE 6	Недопустимый дескриптор. Это значение возвращается, если параметр hRegBatch имеет значение NULL.
ERROR_OUTOFMEMORY 14 (0xE)	Недостаточно места в хранилище для завершения этой операции.
ERROR_GEN_FAILURE 31 (0x1F)	Устройство, подключенное к системе, не работает.
ERROR_INVALID_PARAMETER 87 (0x57)	Неправильный параметр". Это значение будет возвращено, если раздел реестра кластера, в который пакет пытается выполнить команды, не является текущим разделом.

Требования

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