CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES control code
Retrieves a list of the read/write cluster common property names. Applications use this control code as a ClusterControl parameter.
ClusterControl( hCluster, // cluster handle
hHostNode, // optional node handle
CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES, // this control code
NULL, // not used
0, // not used
lpOutBuffer, // output buffer: array of strings
cbOutBufferSize, // output buffer size (bytes)
lpcbBytesReturned ); // resulting data size (bytes)
Parameters
The following ClusterControl function parameter is specific to the CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES control code.
-
lpOutBuffer [out, optional]
-
On a successful return, lpOutBuffer contains an array of NULL-terminated Unicode strings with an additional NULL terminator appended to the last string. Each string in the array contains the name of a read/write cluster common property.
Return value
When the CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES control code is used as a possible value for dwControlCode, ClusterControl returns one of the following values.
-
ERROR_SUCCESS
-
0 (0x0)
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. This value is returned if 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
The CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES control code returns only property names, not property values. To retrieve values for common cluster properties, use CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES and CLUSCTL_CLUSTER_GET_RO_COMMON_PROPERTIES.
ClusAPI.h defines the 32 bits of CLUSCTL_CLUSTER_ENUM_COMMON_PROPERTIES 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_ENUM_COMMON_PROPERTIES (0x51) |
| 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 Enterprise, Windows Server 2008 Datacenter |
| Header |
|