CLUSCTL_CLUSTER_SHUTDOWN control code
Instructs the server to inform every active node in the cluster to stop participating in the cluster. Applications use this control code as a parameter to the ClusterControl function.
ClusterControl( hCluster, // cluster handle
hHostNode, // optional node handle
CLUSCTL_CLUSTER_SHUTDOWN, // this control code
lpInBuffer, // input buffer: 0
nInBufferSize, // input buffer size (bytes)
lpOutBuffer, // output buffer: NULL
cbOutBufferSize, // output buffer size (bytes)
lpcbBytesReturned ); // returned data size (bytes)
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterControl.
-
lpOutBuffer
-
After successful completion of the method, no data should be written to the buffer that lpOutBuffer points to.
Return value
ClusterControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successful. 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
ClusAPI.h defines the 32 bits of CLUSCTL_CLUSTER_SHUTDOWN (0x0700004d) 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_CHECK_VOTER_EVICT (0x45) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
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 |
|