CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTY_FMTS control code

Article
05/31/2018

Retrieves a property list describing the format of each resource private property. Applications use this control code as a parameter to the ClusterResourceControl function.

ClusterResourceControl( hResource,                                  // cluster handle
                        hHostNode,                                  // optional node handle
                        CLUSCTL_RESOURCE_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 ClusterResourceControl.

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

Return value

ClusterResourceControl 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.

Implementations of ResourceControl can return the above values or the following value.

ERROR_INVALID_FUNCTION

Incorrect function. Requests that the Resource Monitor perform default processing (if any) for the control code addition to processing supplied by the DLL (if any).

Remarks

The property list returned by CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTY_FMTS contains one entry for each resource 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_GET_PRIVATE_PROPERTY_FMTS as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE (0x1)
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_GET_PRIVATE_PROPERTY_FMTS (0x8d)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Resource DLL Support

Required. Return a property list that describes the formats of all of your resource-specific private properties (see Remarks below).

As a general guideline, the Resource Monitor should handle all of the control codes for common properties, while your DLL should handle all control codes for private properties.

For more information on the ResourceControl entry point function, see Implementing ResourceControl.

Requirements


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

Share via