Skip to content

Latest commit

 

History

History
164 lines (110 loc) · 5.52 KB

ns-clusapi-cluster_batch_command.md

File metadata and controls

164 lines (110 loc) · 5.52 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:clusapi._CLUSTER_BATCH_COMMAND
CLUSTER_BATCH_COMMAND (clusapi.h)
Represents the order in which current batch command data is sent to the ClusterRegBatchReadCommand function.
CLUSREG_CREATE_KEY
CLUSREG_DELETE_KEY
CLUSREG_DELETE_VALUE
CLUSREG_SET_VALUE
CLUSREG_VALUE_DELETED
CLUSTER_BATCH_COMMAND
CLUSTER_BATCH_COMMAND structure [Failover Cluster]
clusapi/CLUSTER_BATCH_COMMAND
mscs.cluster_batch_command
mscs\cluster_batch_command.htm
MsCS
31f8e255-80c8-4381-a8f3-0d48a3831a89
12/05/2018
CLUSREG_CREATE_KEY, CLUSREG_DELETE_KEY, CLUSREG_DELETE_VALUE, CLUSREG_SET_VALUE, CLUSREG_VALUE_DELETED, CLUSTER_BATCH_COMMAND, CLUSTER_BATCH_COMMAND structure [Failover Cluster], clusapi/CLUSTER_BATCH_COMMAND, mscs.cluster_batch_command
clusapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Windows
CLUSTER_BATCH_COMMAND
19H1
_CLUSTER_BATCH_COMMAND
clusapi/_CLUSTER_BATCH_COMMAND
CLUSTER_BATCH_COMMAND
clusapi/CLUSTER_BATCH_COMMAND
c++
APIRef
kbSyntax
HeaderDef
ClusAPI.h
CLUSTER_BATCH_COMMAND

CLUSTER_BATCH_COMMAND structure

-description

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.

-struct-fields

-field 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.

-field 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.

-field wzName

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

-field 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.

-field 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.

-see-also

CLUSTER_REG_COMMAND

ClusterRegBatchAddCommand

ClusterRegBatchCloseNotification

ClusterRegBatchReadCommand

ClusterRegCreateBatch

Failover Cluster Structures