ClusterRegCreateBatch function (clusapi.h)
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, optional] HKEY hKey,
[out] HREGBATCH *pHREGBATCH
);
Parameters
[in, optional] hKey
The handle of the opened cluster registry key. All the operations on the batch are relative to this cluster registry key.
[out] pHREGBATCH
The pointer to the handle of the created batch.
Return value
The function returns one of the following system error codes.
Return code/value | Description |
---|---|
|
The operation was successful. |
|
Not enough storage is available to complete this operation. |
|
A device attached to the system is not functioning. |
|
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
Requirement | Value |
---|---|
Minimum supported client | None supported |
Minimum supported server | Windows Server 2008 Datacenter, Windows Server 2008 Enterprise |
Target Platform | Windows |
Header | clusapi.h |
Library | ClusAPI.lib |
DLL | ClusAPI.dll |