ClusterRegCloseReadBatchEx function (clusapi.h)

Article
02/22/2024

Executes a read batch and returns results from the read batch executions.

Syntax

LONG ClusterRegCloseReadBatchEx(
  [in]  HREGREADBATCH      hRegReadBatch,
        DWORD              flags,
  [out] HREGREADBATCHREPLY *phRegReadBatchReply
);

Parameters

[in] hRegReadBatch

The handle of the read batch. After the ClusterRegCloseReadBatch function completes, this handle is no longer valid, and memory associated with it is freed.

flags

The flags for the operation.

None (0)

IsolatedRead (2)

[out] phRegReadBatchReply

A pointer to the handle of the created read batch result. You must close this handle later by calling the ClusterRegCloseReadBatchReply function.

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.
ERROR_INVALID_HANDLE 6	hRegReadBatch is NULL or not valid.

Requirements

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