Windows Dev Center

ClusterRegCreateBatch Function

Creates a batch that will execute commands on a cluster registry key. These commands will be added to the batch by the ClusterRegBatchAddCommand function and either executed or ignored by the ClusterRegCloseBatch function.

Syntax


LONG ClusterRegCreateBatch(
  __in_opt  HKEY hKey,
  __out     HREGBATCH *pHREGBATCH
);

Parameters

hKey [in, optional]

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

pHREGBATCH [out]

The pointer to the handle of the created batch.

Return Value

The function returns one of the following system error codes.

Return code/valueDescription

ERROR_SUCCESS
0

The operation was successful.

ERROR_OUTOFMEMORY
14
0xE

Not enough storage is available to complete this operation.

ERROR_GEN_FAILURE
31
0x1F

A device attached to the system is not functioning.

ERROR_INVALID_PARAMETER
87
0x57

The parameter is incorrect. This value will be returned if the hKey parameter is NULL.

Remarks

The key should not be closed until the batch has been submitted for execution.

The PCLUSTER_REG_CREATE_BATCH type defines a pointer to this function.

Requirements

Minimum supported clientNone supported
Minimum supported serverWindows Server 2008 Datacenter Edition, Windows Server 2008 Enterprise Edition
HeaderClusApi.h
LibraryClusApi.lib
DLLClusApi.dll

See Also

Cluster Registry Access Functions
ClusterRegBatchAddCommand
ClusterRegCloseBatch


Send comments about this topic to Microsoft

Build date: 2/9/2009

Community Additions

Show:
© 2015 Microsoft