ClusterRegCloseBatch function (clusapi.h)
Executes or ignores the batch created by the ClusterRegCreateBatch function.
Syntax
LONG ClusterRegCloseBatch(
[in] HREGBATCH hRegBatch,
[in] BOOL bCommit,
[out, optional] INT *failedCommandNumber
);
Parameters
[in] hRegBatch
The handle of the cluster registry key opened by ClusterRegCreateBatch. After the completion of ClusterRegCloseBatch, this handle is no longer valid and memory associated with it is freed.
[in] bCommit
If the value this parameter takes is true, then a batch is sent for execution to a cluster server.
[out, optional] failedCommandNumber
If execution of the batch is not successful, the number of the command that failed is returned in the form of a failedCommandNumber argument. The first command in the batch has number 0, the second has number 1, and so on.
Return value
The function returns one of the following system error codes.
| Return code/value | Description |
|---|---|
|
The operation was successful. |
|
The handle is not valid. This value is returned if the hRegBatch parameter is NULL. |
Remarks
If a failure has occurred before any command was executed, the failedCommandNumber parameter is set to –1.
The PCLUSTER_REG_CLOSE_BATCH type defines a pointer to this function.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 Datacenter, Windows Server 2008 Enterprise |
| Target Platform | Windows |
| Header | clusapi.h |
| Library | ClusAPI.lib |
| DLL | ClusAPI.dll |