ClusterRegCloseReadBatch function (clusapi.h)

  • Article

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

Syntax

LONG ClusterRegCloseReadBatch(
  [in]  HREGREADBATCH      hRegReadBatch,
  [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.

[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.

Remarks

Create the read batch by calling the ClusterRegCreateReadBatch function.

Requirements

Requirement Value
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

ClusterRegCreateReadBatch

ClusterRegReadBatchAddCommand