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_CREATE_KEY 之前，任何对值操作的命令都不能遵循 CLUSREG_DELETE_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 发出的命令的数据的指针。除 CLUSREG_SET_VALUE 命令之外，此参数的值为 NULL。

[in] cbData

相对于 dwCommand 发出的命令的数据计数（以字节为单位）。除 CLUSREG_SET_VALUE 命令之外，此参数的值为 0。

返回值

函数返回以下系统错误代码之一。

返回代码/值	说明
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)	参数不正确。如果批处理尝试执行命令的群集注册表项不是当前键，则将返回此值。

注解

PCLUSTER_REG_BATCH_ADD_COMMAND类型定义指向此函数的指针。

要求

要求	值
最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows Server 2008 Datacenter、Windows Server 2008 Enterprise
目标平台	Windows
标头	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll