CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES control code
Retrieves a list of the read/write private and read-only resource properties. Applications use this control code as a ClusterResourceControl parameter, and resource DLLs receive the control code as a ResourceControl parameter.
ClusterResourceControl(
hResource, // resource handle
hHostNode, // optional host node
CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES, // this control code
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: array of strings
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 ClusterResourceControl or ResourceControl.
-
lpOutBuffer
-
On a successful return, contains an array of null-terminated Unicode strings with an additional NULL terminator appended to the last string. Each string in the array contains the name of a read/write private resource 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)
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 in addition to processing supplied by the DLL (if any).
Remarks
The CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES control code returns only property names, not property values. To retrieve values for common resource properties, use CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTIES and CLUSCTL_RESOURCE_GET_RO_PRIVATE_PROPERTIES.
For more information, see Getting Information with Control Codes.
Do not use the CLUSCTL_RESOURCE_ENUM_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_ENUM_PRIVATE_PROPERTIES 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_ENUM_PRIVATE_PROPERTIES (0x79) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Resource DLL Support
Required. Always support the CLUSCTL_RESOURCE_ENUM_PRIVATE_PROPERTIES control code by returning the names of the resource's private properties in the OutBuffer parameter.
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 |
|