ClusterRegCreateBatch function (clusapi.h)

Article
02/22/2024

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.

Syntax

LONG ClusterRegCreateBatch(
  [in, optional] HKEY      hKey,
  [out]          HREGBATCH *pHREGBATCH
);

Parameters

[in, optional] hKey

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

[out] pHREGBATCH

The pointer to the handle of the created batch.

Return value

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.

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