CLUSCTL_CLUSTER_GET_GUM_LOCK_OWNER control code
Retrieves the name of the current Global Update Manager (GUM) lock owner for a cluster. Applications use this control code as a ClusterControl parameter.
ClusterControl(
hCluster, // cluster handle
hHostNode, // optional node handle
CLUSCTL_CLUSTER_GET_GUM_LOCK_OWNER, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: GUM ID and lock owner name
cbOutBufferSize, // output buffer size (bytes)
lpcbBytesReturned // resulting data size (bytes)
);
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterControl.
-
lpOutBuffer
-
When this method returns, contains the current GUM identifier, followed by the current GUM lock owner name.
-
lpcbBytesReturned
-
When this method returns, contains the combined size, in bytes, of a DWORD and the GUM lock owner name.
Return value
ClusterControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.
-
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.
-
If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.
Remarks
When assessing a lock situation, make sure that the GUM identifier is for this control code is the same as the GUM identifier retrieved in the CLUSCTL_NODE_GET_STUCK_NODES (0x070002B9) control code. The GUM identifiers also need to be the same for a period before assuming that a lock has occurred.
The 32 bits of CLUSCTL_CLUSTER_GET_GUM_LOCK_OWNER are defined as follows (for more information, see Control Code Architecture).
| 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_GET_GUM_LOCK_OWNER (0x2b9) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise |
| Header |
|