CLUSTER_BATCH_COMMAND structure (clusapi.h)

Article
04/02/2021

Represents the order in which current batch command data is sent to the ClusterRegBatchReadCommand function. Values in the CLUSTER_BATCH_COMMAND structure are identical to parameters passed to the ClusterRegBatchAddCommand function. The only difference is that for CLUSREG_DELETE_VALUE, the dwOptions, lpData, and cbData members are set to the value being deleted, similar to the CLUSREG_SET_VALUE command.

Syntax

typedef struct _CLUSTER_BATCH_COMMAND {
  CLUSTER_REG_COMMAND Command;
  DWORD               dwOptions;
  LPCWSTR             wzName;
  BYTE const          *lpData;
  DWORD               cbData;
} CLUSTER_BATCH_COMMAND;

Members

Command

A command that is supported by this API and taken from the CLUSTER_REG_COMMAND enumeration. The possible commands are as follows.

CLUSREG_SET_VALUE (1)

Sets a value relative to the last executed CLUSREG_CREATE_KEY command or (if not provided) relative to a key passed into the ClusterRegCreateBatch function.

CLUSREG_CREATE_KEY (2)

Creates a specified cluster registry key if it does not exist, or opens an existing one.

CLUSREG_DELETE_KEY (3)

Deletes a key with all values and nested subkeys. No commands that operate on values can follow CLUSREG_DELETE_KEY until CLUS_REG_CREATE_KEY is added.

CLUSREG_DELETE_VALUE (4)

Deletes a value relative to the last executed CLUSREG_CREATE_KEY command or (if not provided) relative to a key passed into the ClusterRegCreateBatch function.

CLUSREG_VALUE_DELETED (6)

Indicates whether a specific cluster registry value has been deleted or if the data of that cluster registry value has been changed. This command is returned only through a batch update notification port.

dwOptions

If the Command member takes either the CLUSREG_SET_VALUE command or the CLUSREG_DELETE_VALUE command, then this member takes one of the standard registry value types. If not, then Command is set to 0.

wzName

The name of the value or key relative to the command issued by Command.

lpData

A pointer to the data relative to the command issued by Command. The value of this member is NULL for all the commands except the CLUSREG_SET_VALUE and CLUSREG_DELETE_VALUE commands.

cbData

The count, in bytes, of the data relative to the command issued by Command. The value of this member is 0 for all the commands except the CLUSREG_SET_VALUE and CLUSREG_DELETE_VALUE commands.

Remarks

The wzName and lpData pointers are valid until the batch notification is closed via the ClusterRegBatchCloseNotification function.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Header	clusapi.h