CLUSCTL_RESOURCE_VALIDATE_PRIVATE_PROPERTIES control code

Verifies that a property list contains valid resource private 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_PRIVATE_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 private resource properties.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

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.

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

1

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

Remarks

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

Do not use the CLUSCTL_RESOURCE_VALIDATE_PRIVATE_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_PRIVATE_PROPERTIES as follows.

For more information, see Control Code Architecture.

Resource DLL Support

Required. Always support the CLUSCTL_RESOURCE_VALIDATE_PRIVATE_PROPERTIES control code. Your implementation should parse the property list passed in the InBuffer parameter, verifying that each property value is valid for the resource.

If you do not support this control code, the Resource Monitor verifies that the property list is formatted correctly but does not actually validate the data. This can result in the assignment of invalid property values.

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

See also

External Resource Control Codes

ClusterResourceControl

ResourceControl