Share via


CLUSCTL_RESOURCE_SET_CSV_MAINTENANCE_MODE control code

Enables or disables maintenance mode for the specified cluster shared volume (CSV). Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl callback function.

ClusterResourceControl( hResource,               // resource handle
                        hHostNode,               // optional node handle
                        CLUSCTL_RESOURCE_SET_CSV_MAINTENANCE_MODE, 
                        lpInBuffer,              // input buffer: maintenence info
                        nInBufferSize,           // input buffer size (bytes)
                        NULL,                    // output buffer (not used)
                        0,                       // output buffer size (not used)
                        NULL );                  // resulting data size (not used)

Parameters

The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpInBuffer

Points to a CLUS_CSV_MAINTENANCE_MODE_INFO structure containing the maintenance mode. The VolumeName field must be set to a unique volume identifier. Set the InMaintenance field to TRUE to enable or FALSE to disable volume maintenance mode for the designated cluster shared volume.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation was successful. 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.

System error code

The operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

The 32 bits of CLUSCTL_RESOURCE_SET_CSV_MAINTENANCE_MODE (0x00400296) are defined as follows.

Component Bit location Value
Object code
24 31
CLUS_OBJECT_RESOURCE (0x1)
Global bit
23
CLUS_NOT_GLOBAL (0x0)
Modify bit
22
CLUS_MODIFY (0x1)
User bit
21
CLCTL_CLUSTER_BASE (0x0)
Type bit
20
External (0x0)
Operation code
0 23
CLCTL_SET_CSV_MAINTENANCE_MODE (0x400296)
Access code
0 1
CLUS_ACCESS_WRITE (0x2)

For more information, see Control Code Architecture.

Requirements

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

See also

External Resource Control Codes

ClusterResourceControl

ResourceControl

CLUS_CSV_MAINTENANCE_MODE_INFO