Share via


CLUSCTL_RESOURCE_TYPE_STORAGE_REMAP_DRIVELETTER control code

Modifies the drive letter of a disk 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( hResource,                                     // resource handle
                            lpszResTypeName,                               // resource type name
                            hHostNode,                                     // optional host node
                            CLUSCTL_RESOURCE_TYPE_STORAGE_IS_CLUSTERABLE,  // this control code
                            lpInBuffer,                                    // input buffer: drive letter bitmasks
                            cbInBufferSize,                                // input buffer size (bytes)
                            lpOutBuffer,                                   // output buffer (not used)
                            cbOutBufferSize,                               // allocated buffer size (not used)
                            lpcbBytesReturned );                           // actual size of resulting data (not used)

Parameters

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

lpInBuffer

Contains bitmasks for the current and new drive letters. This parameter is modeled according to the CLUS_STORAGE_REMAP_DRIVELETTER structure.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully.

ERROR_INVALID_PARAMETER

87 (0x57)

The parameter is incorrect. This value can be returned if the input buffer pointed to by lpInBuffer was not large enough to hold the data resulting from the operation. This value can also be returned if CurrentDriveLetterMask, one of the members of the CLUS_STORAGE_REMAP_DRIVELETTER structure, is zero.

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_REMAP_DRIVELETTER (0x02000201) 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_REMAP_DRIVELETTER (0x201)
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

CLUS_STORAGE_REMAP_DRIVELETTER

ClusterResourceTypeControl

ResourceTypeControl