CLUSCTL_RESOURCE_VALIDATE_COMMON_PROPERTIES control code

Article
05/31/2018

Verifies that a property list contains valid resource common property names and values and that the list is properly formatted. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.

ClusterResourceControl( hResource,                                   // resource handle
                        hHostNode,                                   // optional host node
                        CLUSCTL_RESOURCE_VALIDATE_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 ClusterResourceControl or ResourceControl.

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

Return value

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

RPC_X_BAD_STUB_DATA

1783 (0x6F7)

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

System error code

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

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 CLUSCTL_RESOURCE_VALIDATE_COMMON_PROPERTIES control code only validates read/write common resource properties. Property lists containing private or read-only properties cause validation to fail.

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

Do not use the CLUSCTL_RESOURCE_VALIDATE_COMMON_PROPERTIES control code in any resource DLL entry point function. This control code can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_VALIDATE_COMMON_PROPERTIES as follows.

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_VALIDATE_COMMON_PROPERTIES (0x61)
Access code	0 1	CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture.

Resource DLL Support

Use default. Return ERROR_INVALID_FUNCTION to let the Resource Monitor validate 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 ResourceControl entry point, see Implementing ResourceControl.

Requirements


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

Partager via