CLUSCTL_GROUP_VALIDATE_PRIVATE_PROPERTIES control code
Verifies that a group private property list is properly formatted. Applications use this control code as a ClusterGroupControl parameter.
ClusterGroupControl( hGroup, // group handle
hHostNode, // optional node handle
CLUSCTL_GROUP_VALIDATE_PRIVATE_PROPERTIES, // this control code
lpInBuffer, // input buffer: property list
cbInBufferSize, // input buffer size (bytes)
NULL, // output buffer (not used)
0, // output buffer size (not used)
NULL ); // resulting data size (not used)
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterGroupControl.
-
lpInBuffer
-
Pass a pointer to a property list containing one or more read/write group private properties.
Return value
ClusterGroupControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successfully. The property list is correctly formatted and contains valid data values.
-
ERROR_INSUFFICIENT_BUFFER
-
122 (0x7A)
The data area passed to a system call is too small. The actual size of the property list buffer as determined by the Cluster service is larger than the size specified in the cbInBufferSize parameter.
-
ERROR_INVALID_DATA
-
13 (0xD)
The data is invalid. The property list is either formatted incorrectly or contains invalid data, such as an out-of-range value.
-
ERROR_INVALID_PARAMETER
-
87 (0x57)
The parameter is incorrect.
-
RPC_X_BAD_STUB_DATA
-
1783 (0x6F7)
The stub received bad data. The lpInBuffer parameter is NULL.
-
If any other value is returned, then the operation failed.
Remarks
By default, failover clusters do not define any private properties for groups.
Do not use any group control codes in any resource DLL entry point function. Group control codes can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.
ClusAPI.h defines the 32 bits of CLUSCTL_GROUP_VALIDATE_PRIVATE_PROPERTIES as follows (for more information, see Control Code Architecture).
| Component | Bit location | Value |
|---|---|---|
| Object code |
24 31 |
CLUS_OBJECT_GROUP (0x3) |
| 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_VALIDATE_PRIVATE_PROPERTIES (0x89) |
| Access code |
0 1 |
CLUS_ACCESS_READ (0x1) |
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
| Header |
|