ClusterRegCreateReadBatch function (clusapi.h)

Creates a handle to the read batch that executes read commands on the cluster registry key.

Syntax

LONG ClusterRegCreateReadBatch(
  [in]  HKEY          hKey,
  [out] HREGREADBATCH *phRegReadBatch
);

Parameters

[in] hKey

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

[out] phRegReadBatch

A pointer to the handle of the created read 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
Not enough storage is available to complete this operation.

Remarks

Add commands to the batch by calling the ClusterRegReadBatchAddCommand function. Execute the batch by calling the ClusterRegCloseReadBatch function.

Do not close the key until the read batch has been submitted for execution.

Requirements

   
Minimum supported client None supported
Minimum supported server Windows Server 2012
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also

ClusterRegCloseReadBatch

ClusterRegReadBatchAddCommand