ClusterRegReadBatchReplyNextCommand function (clusapi.h)

Article
02/22/2024

Reads the next command from a read batch result.

Syntax

LONG ClusterRegReadBatchReplyNextCommand(
  [in]  HREGREADBATCHREPLY         hRegReadBatchReply,
  [out] CLUSTER_READ_BATCH_COMMAND *pBatchCommand
);

Parameters

[in] hRegReadBatchReply

A handle to a read batch result that was created by calling the ClusterRegCloseReadBatch function. You must close this handle later by calling the ClusterRegCloseReadBatchReply function.

[out] pBatchCommand

A pointer to a CLUSTER_READ_BATCH_COMMAND structure that contains information about the read command.

Return value

The function returns one of the following system error codes.

Return code/value	Description
ERROR_SUCCESS 0	The operation was successful.
ERROR_INVALID_HANDLE 6	hRegReadBatchReply is NULL or not valid.
ERROR_NO_MORE_ITEMS 259	There is no more information in hRegReadBatchReply.

Remarks

The number of records in the read batch results is equal to the number of commands in the read batch. Also, the results are in the same order as the commands that were added to the read batch.

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