CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_PROPERTY_FMTS control code

Article
05/31/2018

Retrieves a property list describing the format of each resource type private property. Applications use this control code as a ClusterResourceTypeControl parameter.

ClusterResourceTypeControl( hCluster,                                         // cluster handle
                            lpszResTypeName,                                  // resource type name
                            hHostNode,                                        // optional node handle
                            CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_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 ClusterResourceTypeControl.

lpOutBuffer: On a successful return, points to a property list describing the format of each private property.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

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

By default, failover clusters do not define any private properties for resource types. CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_PROPERTY_FMTS does not retrieve information about unknown properties.

The property list returned by CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_PROPERTY_FMTS contains one entry for each resource type private property, formatted as follows.

A CLUSPROP_PROPERTY_NAME structure describing the property name.
Alignment padding (see ALIGN_CLUSPROP).
A CLUSPROP_WORD structure describing the format of the property value.
A CLUSPROP_SYNTAX structure set to CLUSPROP_SYNTAX_ENDMARK, an enumerator from the CLUSTER_PROPERTY_SYNTAX enumeration.

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

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE_TYPE (0x2)
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 (0x1)
Operation code	0 23	CLCTL_GET_PRIVATE_PROPERTY_FMTS (0x8d)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Resource DLL Support

Required if you define private properties for your resource type. Otherwise return ERROR_INVALID_FUNCTION. For more information on the ResourceTypeControl entry point, see Implementing ResourceTypeControl.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Header	ClusAPI.h