Skip to content

Latest commit

 

History

History
135 lines (105 loc) · 3.81 KB

nf-clusapi-clusterregclosebatch.md

File metadata and controls

135 lines (105 loc) · 3.81 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
NF:clusapi.ClusterRegCloseBatch
ClusterRegCloseBatch function (clusapi.h)
Executes or ignores the batch created by the ClusterRegCreateBatch function. (ClusterRegCloseBatch)
ClusterRegCloseBatch
ClusterRegCloseBatch function [Failover Cluster]
PCLUSTER_REG_CLOSE_BATCH
PCLUSTER_REG_CLOSE_BATCH function [Failover Cluster]
clusapi/ClusterRegCloseBatch
clusapi/PCLUSTER_REG_CLOSE_BATCH
mscs.clusterregclosebatch
mscs\clusterregclosebatch.htm
MsCS
d43644cf-370b-499f-b321-24e43f145a98
12/05/2018
ClusterRegCloseBatch, ClusterRegCloseBatch function [Failover Cluster], PCLUSTER_REG_CLOSE_BATCH, PCLUSTER_REG_CLOSE_BATCH function [Failover Cluster], clusapi/ClusterRegCloseBatch, clusapi/PCLUSTER_REG_CLOSE_BATCH, mscs.clusterregclosebatch
clusapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
ClusAPI.lib
ClusAPI.dll
Windows
19H1
ClusterRegCloseBatch
clusapi/ClusterRegCloseBatch
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-1.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-2.dll
ClusterRegCloseBatch

ClusterRegCloseBatch function

-description

Executes or ignores the batch created by the ClusterRegCreateBatch function.

-parameters

-param hRegBatch [in]

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.

-param bCommit [in]

If the value this parameter takes is true, then a batch is sent for execution to a cluster server.

-param failedCommandNumber [out, optional]

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.

-returns

The function returns one of the following system error codes.

Return code/value Description
ERROR_SUCCESS
0
The operation was successful.
ERROR_INVALID_HANDLE
6
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.

-see-also

Cluster Registry Access Functions

ClusterRegBatchAddCommand

ClusterRegCloseBatchEx

ClusterRegCreateBatch