CLUSCTL_RESOURCE_TYPE_SET_COMMON_PROPERTIES control code

Article
05/31/2018

Updates the read/write common properties for a resource type. Applications use this control code as a ClusterResourceTypeControl parameter, and resource DLLs receive the control code as a ResourceTypeControl parameter.

ClusterResourceTypeControl( hCluster,                                          // cluster handle
                            lpszResTypeName,                                   // resource type name
                            hHostNode,                                         // optional host node
                            CLUSCTL_RESOURCE_TYPE_SET_COMMON_PROPERTIES,       // this control code
                            lpInBuffer,                                        // input buffer: property list
                            cbInBufferSize,                                    // allocated buffer size (bytes)
                            NULL,                                              // output buffer: (not used)
                            0,                                                 // output buffer size (not used)
                            NULL );                                            // actual size of resulting data (not used)

Parameters

The following control code function and DLL support parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.

lpInBuffer: Points to a property list containing one or more read/write common resource type properties.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

The operation completed successfully. The property list is correctly formatted and contains valid data values.

ERROR_INSUFFICIENT_BUFFER

122 (0x7A)

The data area passed to a system call is too small. The actual size of the property list buffer as determined by the Cluster service is larger than the size specified in the cbInBufferSize parameter.

ERROR_INVALID_DATA

13 (0xD)

The data is invalid. The property list is either formatted incorrectly or contains invalid data, such as an out-of-range value.

ERROR_INVALID_PARAMETER

87 (0x57)

The parameter is incorrect. The property list is not formatted correctly.

RPC_X_BAD_STUB_DATA

1783 (0x6F7)

The stub received bad data. The lpInBuffer parameter is NULL.

ERROR_RESOURCE_PROPERTIES_STORED

5024 (0x13A0)

The properties were stored but not all changes will take effect until the next time the resource is brought online.

System error code

If any other value is returned, then the operation failed.

Remarks

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

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_SET_COMMON_PROPERTIES 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_MODIFY (0x1)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_SET_COMMON_PROPERTIES (0x40005e)
Access code	0 1	CLUS_ACCESS_WRITE (0x2)

Resource DLL Support

Use default. Return ERROR_INVALID_FUNCTION to let the Resource Monitor set the properties in the cluster database.

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 ResourceTypeControl entry point, see Implementing ResourceTypeControl.

Requirements


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

Share via