Edit

IVdsVolumeMF3::OfflineVolume method (vds.h)

  • Article

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Takes the volume offline by using the IOCTL_VOLUME_OFFLINE control code.

Syntax

HRESULT OfflineVolume();

Return value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code Description
S_OK
 The method completed successfully.

Remarks

If the volume is already offline, the OfflineVolume method returns S_OK.

When a volume is offline, all read, write, and IOCTL requests fail with ERROR_NOT_READY. You cannot take the system or boot volume offline.

When a volume is online, all requests sent to the volume are honored.

When a volume that is online is dismounted, the next call to open the volume causes it to be mounted. Taking the volume offline prevents the dismounted volume from being mounted again. To dismount a volume, use the IVdsVolumeMF::Dismount method.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header vds.h
Library Uuid.lib

See also

IVdsVolumeMF3