CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES control code

Retrieves the read/write cluster common properties for a cluster. Applications use this control code as a ClusterControl parameter.

ClusterControl( 
  hCluster,                               // cluster handle
  hHostNode,                              // optional node handle
  CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES,  // this control code
  NULL,                                   // input buffer (not used)
  0,                                      // input buffer size (not used)
  lpOutBuffer,                            // output buffer: property list
  cbOutBufferSize,                        // output buffer size (bytes)
  lpcbBytesReturned                       // resulting data size (bytes)
);

Parameters

For complete parameter descriptions, see ClusterControl. The following control code function parameter is specific to the CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES control code.

lpOutBuffer

On a successful return, points to a property list containing the specified cluster's read/write cluster common properties.

Return value

When an application uses CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES as a parameter for ClusterControl, ClusterControl returns one of the following values:

ERROR_SUCCESS

0

The operation completed successfully. This value is returned if 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.

System error code

If any other value is returned, the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

For information on working with property lists, see Using Property Lists.

ClusAPI.h defines the 32 bits of CLUSCTL_CLUSTER_GET_COMMON_PROPERTIES as follows (for more information, see Control Code Architecture).

Requirements

See also

Cluster Control Codes

ClusterControl