Private Resource Properties

Private resource properties are data values that apply to resources of a particular type. Private resource properties can be static values stored in the cluster database, static values stored elsewhere, or dynamic values generated on demand.

To access private resource properties, applications typically call ClusterResourceControl with one of the following values for the dwControlCode parameter:

• CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES to retrieve the names of a resource's private properties.
• CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTIES to retrieve the names and values of a resource's private properties that can be modified.
• CLUSCTL_RESOURCE_GET_RO_PRIVATE_PROPERTIES to retrieve the names and values of a resource's private properties that cannot be modified.
• CLUSCTL_RESOURCE_SET_PRIVATE_PROPERTIES to update the values of a resource's private properties.
• CLUSCTL_RESOURCE_VALIDATE_PRIVATE_PROPERTIES to validate a resource's private properties.

For the get, set, and validate operations, ClusterResourceControl either requires as input or returns as output a property list that contains an entry for every property. Each entry has two parts: a property name and a property value. The property name contains a syntax value, a string describing the name, the length of the string, and padding if necessary to properly align the name. The property value is similar to the name in that it also contains a syntax value and a length. The data portion varies depending on the type of property. For most properties, a cluster structure such as CLUSPROP_SZ or CLUSPROP_DWORD is used to store the property value in the property list.

The Quick Info tables that appear with each property describe the following pieces of information:

• Property type.
• Property access level.
• Functions that can be called to access the property such as ClusterResourceControl.
• Structures that are used as input to or output from a property operation.
• Control codes that can be passed to ClusterResourceControl to retrieve the property.