Skip to content

Latest commit

 

History

History
149 lines (122 loc) · 3.52 KB

nf-clusapi-clusterregcreatebatch.md

File metadata and controls

149 lines (122 loc) · 3.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
NF:clusapi.ClusterRegCreateBatch
ClusterRegCreateBatch function (clusapi.h)
Creates a batch that will execute commands on a cluster registry key.
ClusterRegCreateBatch
ClusterRegCreateBatch function [Failover Cluster]
PCLUSTER_REG_CREATE_BATCH
clusapi/ClusterRegCreateBatch
mscs.clusterregcreatebatch
mscs\clusterregcreatebatch.htm
MsCS
83e7c216-f08f-4dc2-9b53-faa2760985d4
12/05/2018
ClusterRegCreateBatch, ClusterRegCreateBatch function [Failover Cluster], PCLUSTER_REG_CREATE_BATCH, clusapi/ClusterRegCreateBatch, mscs.clusterregcreatebatch
clusapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
ClusAPI.lib
ClusAPI.dll
Windows
19H1
ClusterRegCreateBatch
clusapi/ClusterRegCreateBatch
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-1.dll
Ext-MS-Win-Cluster-ClusAPI-l1-1-2.dll
ClusterRegCreateBatch

ClusterRegCreateBatch function

-description

Creates a batch that will execute commands on a cluster registry key. These commands will be added to the batch by the ClusterRegBatchAddCommand function and either executed or ignored by the ClusterRegCloseBatch function.

-parameters

-param hKey [in, optional]

The handle of the opened cluster registry key. All the operations on the batch are relative to this cluster registry key.

-param pHREGBATCH [out]

The pointer to the handle of the created batch.

-returns

The function returns one of the following system error codes.

Return code/value Description
ERROR_SUCCESS
0
The operation was successful.
ERROR_OUTOFMEMORY
14 (0xE)
Not enough storage is available to complete this operation.
ERROR_GEN_FAILURE
31 (0x1F)
A device attached to the system is not functioning.
ERROR_INVALID_PARAMETER
87 (0x57)
The parameter is incorrect. This value will be returned if the hKey parameter is NULL.

-remarks

The key should not be closed until the batch has been submitted for execution.

The PCLUSTER_REG_CREATE_BATCH type defines a pointer to this function.

-see-also

Cluster Registry Access Functions

ClusterRegBatchAddCommand

ClusterRegCloseBatch