CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_PROPERTIES control code
Retrieves the read/write private 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_GET_PRIVATE_PROPERTIES, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: property list
cbOutBufferSize, // allocated buffer size (bytes)
lpcbBytesReturned ); // actual size of resulting data (bytes)
Parameters
The following control code function and DLL support parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.
-
lpOutBuffer
-
On a successful return, points to a property list containing the resource type's read/write private properties.
Return value
ClusterResourceTypeControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.
-
ERROR_MORE_DATA
-
234 (0xEA)
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.
-
If any other value is returned, then the operation was not successful. The lpcbBytesReturned parameter points to an unreliable value.
Remarks
ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_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_NO_MODIFY (0x0) |
| User bit | 21 | CLCTL_CLUSTER_BASE (0x0) |
| Type bit | 20 | External (0x0) |
| Operation code | 0 23 | CLCTL_GET_PRIVATE_PROPERTIES (0x81) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Resource DLL Support
Required. Always support CLUSCTL_RESOURCE_TYPE_GET_PRIVATE_PROPERTIES in your implementation of ResourceTypeControl. Return a property list that includes the names and data values for all of the resource type-specific read/write private properties. Remember to terminate the list with CLUSPROP_SYNTAX_ENDMARK. For more information on working with property lists, see Creating Property Lists.
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 |
|