CLUSCTL_RESOURCE_GET_COMMON_PROPERTY_FMTS control code
Retrieves a property list describing the format of each resource common property. Applications use this control code as a ClusterResourceControl parameter.
ClusterResourceControl(
hResource, // resource handle
hHostNode, // optional node handle
CLUSCTL_RESOURCE_GET_COMMON_PROPERTY_FMTS, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: property list
cbOutBufferSize, // output buffer size (bytes)
lpcbBytesReturned // resulting data size (bytes)
);
Parameters
The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.
-
lpOutBuffer
-
On a successful return, points to a property list describing the format of each resource common property.
Return value
ClusterResourceControl returns one of the following values.
-
ERROR_SUCCESS
-
0
The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.
-
ERROR_MORE_DATA
-
234 (0xEA)
More data is available. 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 failed. The value of lpcbBytesReturned is unreliable.
Implementations of ResourceControl can return the above values or the following value.
-
ERROR_INVALID_FUNCTION
-
1
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
For information on working with property lists, see Using Property Lists.
ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_GET_COMMON_PROPERTY_FMTS as follows (for more information, see Control Code Architecture).
| 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_GET_COMMON_PROPERTY_FMTS (0x65) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Resource DLL Support
Use default. Return ERROR_INVALID_FUNCTION to let the Resource Monitor create the property list. The Resource Monitor will return a version-appropriate list of common resource properties.
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 function, see Implementing ResourceControl.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise |
| Header |
|