CLUSCTL_CLUSTER_BATCH_BLOCK_KEY Control Code
Blocks updates to a registry key until a timeout or matching CLUSCTL_CLUSTER_BATCH_UNBLOCK_KEY control code. Applications use this control code as a parameter to the ClusterControl function. If not unblocked the block will timeout after 15 seconds. Only one block may be in place at a time.
ClusterControl( hCluster, // cluster handle
hHostNode, // optional node handle
CLUSCTL_CLUSTER_BATCH_BLOCK_KEY, // this control code
lpInBuffer, // input buffer: name of registry key to block
nInBufferSize, // input buffer size (bytes)
NULL, // output buffer (not used)
0, // output buffer size (not used)
NULL ); // returned data size (not used)
Parameters
The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterControl.
- lpInBuffer
Points to a NULL-terminated Unicode string containing the name of the registry key to be blocked for batch operations.
Return Value
ClusterControl returns one of the following values.
ERROR_SUCCESS
0The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.
ERROR_ALREADY_EXISTS
183 (0xB7)Another block is currently active. Only one block may be active at a time.
ERROR_MORE_DATA
234 (0xEA)More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.
System error code
The operation failed. The value of lpcbBytesReturned is unreliable.
Remarks
ClusApi.h defines the 32 bits of CLUSCTL_CLUSTER_BATCH_BLOCK_KEY (0x0700023e) as follows.
| Component | Bit location | Value |
|---|---|---|
Object code |
24–31 |
CLUS_OBJECT_CLUSTER (0x7) |
Global bit |
23 |
CLUS_NOT_GLOBAL (0x0) |
Modify bit |
22 |
CLUS_NO_MODIFY (0x0) |
User bit |
21 |
CLCTL_CLUSTER_BASE (0x0) |
Type bit |
20 |
External (0x0) |
Operation code |
0–23 |
CLCTL_BATCH_BLOCK_KEY (0x23e) |
Access code |
0–1 |
CLUS_ACCESS_WRITE (0x2) |
For more information, see Control Code Architecture.
Requirements
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 Datacenter, Windows Server 2008 Enterprise |
| Header | ClusApi.h |
See Also
CLUSCTL_CLUSTER_BATCH_UNBLOCK_KEY
Send comments about this topic to Microsoft
Build date: 5/20/2009