ClusterRegReadBatchAddCommand function (clusapi.h)

  • Article

Adds a read command to a batch that executes on a cluster registry key.

Syntax

LONG ClusterRegReadBatchAddCommand(
  [in]           HREGREADBATCH hRegReadBatch,
  [in, optional] LPCWSTR       wzSubkeyName,
  [in, optional] LPCWSTR       wzValueName
);

Parameters

[in] hRegReadBatch

The handle of the read batch to which a command will be added. Create a batch by calling the ClusterRegCreateReadBatch function.

[in, optional] wzSubkeyName

The name of the key relative to the cluster registry key. If this name is NULL, the read is performed on the cluster registry key represented in the hRegReadBatch parameter.

[in, optional] wzValueName

The name of the registry value to be read. If this name is NULL, the content of the default value is returned.

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

Additional calls to the ClusterRegReadBatchAddCommand function add additional read commands to the 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

See also

ClusterRegCreateReadBatch