CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS control code
Retrieves information about storage class devices supported by a resource type. Applications use this control code as a parameter to the ClusterResourceTypeControl function, and resource DLLs receive the control code as a parameter to the ResourceTypeControl callback function.
ClusterResourceTypeControl( hCluster, // cluster handle
lpszResTypeName, // resource type name
hHostNode, // optional host node
CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS,
NULL, // input buffer (not used)
0, // input buffer size (not used)
lpOutBuffer, // output buffer: value list
cbOutBufferSize, // allocated buffer size (bytes)
lpcbBytesReturned ); // size of returned 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 value list describing all available storage class devices in the cluster supported by the resource type specified by lpszResTypeName.
- For information on the format of this list see Value Lists for Storage Class Resources.
- A storage class device is available if it is not currently owned by a node. Because resources are always owned by a node at any point in time, storage class devices configured as resources will not be included in the returned value list.
- Any given storage class resource can appear more than once in the list.
Return value
ClusterResourceTypeControl 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 ResourceTypeControl 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 examples of using CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS, see Creating a Physical Disk Resource. For information on accessing the data in a value list, see Parsing a Value List.
ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS as follows.
| 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_AVAILABLE_DISKS |
| Access code |
0 1 |
CLUS_ACCESS_READ (0x1) |
For more information, see Control Code Architecture.
Resource DLL Support
Conditional. If your DLL handles quorum-capable resource storage class resources, you must support the CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS control code. Create and return a value list formatted as described under lpOutBuffer. For more information, see Creating a Value List and Implementing ResourceTypeControl.
Otherwise, return ERROR_INVALID_FUNCTION.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |
| Header |
|