Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ClusterRegCloseBatch function

Executes or ignores the batch created by the ClusterRegCreateBatch function.

Syntax


LONG WINAPI ClusterRegCloseBatch(
  _In_      HREGBATCH hRegBatch,
  _In_      BOOL      bCommit,
  _Out_opt_ INT       *failedCommandNumber
);

typedef LONG (WINAPI *PCLUSTER_REG_CLOSE_BATCH)(
    _In_      HREGBATCH hRegBatch,
    _In_      BOOL      bCommit,
    _Out_opt_ INT       *failedCommandNumber
);

Parameters

hRegBatch [in]

The handle of the cluster registry key opened by ClusterRegCreateBatch. After the completion of ClusterRegCloseBatch, this handle is no longer valid and memory associated with it is freed.

bCommit [in]

If the value this parameter takes is true, then a batch is sent for execution to a cluster server.

failedCommandNumber [out, optional]

If execution of the batch is not successful, the number of the command that failed is returned in the form of a failedCommandNumber argument. The first command in the batch has number 0, the second has number 1, and so on.

Return value

The function returns one of the following system error codes.

ERROR_SUCCESS

0

The operation was successful.

ERROR_INVALID_HANDLE

6

The handle is not valid. This value is returned if the hRegBatch parameter is NULL.

Remarks

If a failure has occurred before any command was executed, the failedCommandNumber parameter is set to –1.

The PCLUSTER_REG_CLOSE_BATCH type defines a pointer to this function.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Datacenter, Windows Server 2008 Enterprise

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Cluster Registry Access Functions
ClusterRegCloseBatchEx
ClusterRegCreateBatch
ClusterRegBatchAddCommand

 

 

Show: