CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS control code

Retrieves a property list describing the format of each cluster common property. Applications use this control code as a parameter to the ClusterControl function.

ClusterControl( hCluster,                               // cluster handle
                hHostNode,                              // optional node handle
                CLUSCTL_CLUSTER_GET_COMMON_PROPERTY_FMTS,  // 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

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

lpOutBuffer

On a successful return, points to a property list describing the format of each common property.

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.

System error code

If any other value is returned, then 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_PROPERTY_FMTS as follows (for more information, see Control Code Architecture).

Requirements

See also

Cluster Control Codes

ClusterControl