CLUSCTL_RESOURCE_TYPE_STORAGE_GET_DRIVELETTERS control code

Queries a bitmask of the driver letters that are not in use on the designated node. Applications use this control code as a parameter to 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_DRIVELETTERS, // this control code
                            lpInBuffer,                                     // input buffer: (not used, but required)
                            cbInBufferSize,                                 // input buffer size: size of lpOutBuffer
                            lpOutBuffer,                                    // output buffer: drive letter bitmask
                            cbOutBufferSize,                                // allocated buffer size
                            lpcbBytesReturned );                            // size of returned data

Parameters

The following control code function and DLL support parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.

lpOutBuffer

On a successful return, points to a CLUS_STORAGE_GET_AVAILABLE_DRIVELETTERS structure indicating the drive letters not in use.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully.

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.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_STORAGE_GET_DRIVELETTERS (0x020001ed) 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_STORAGE_GET_DRIVELETTERS (0x1ed)
Access code 0 1 CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Header
ClusAPI.h

See also

External Resource Type Control Codes

ClusterResourceTypeControl

ResourceTypeControl

CLUS_STORAGE_GET_AVAILABLE_DRIVELETTERS