IVdsVolumeMF::Dismount method (vds.h)

Article
02/09/2023

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

Dismounts a mounted volume.

Syntax

HRESULT Dismount(
  [in] BOOL bForce,
  [in] BOOL bPermanent
);

Parameters

[in] bForce

If TRUE, the volume is dismounted even if it is in use; otherwise, the operation fails if the volume is in use.

[in] bPermanent

If TRUE, the volume remains dismounted until an access path is added.

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/value	Description
S_OK	The method completed successfully.
VDS_E_VOLUME_TEMPORARILY_DISMOUNTED 0x8004245CL	The volume is already dismounted.
VDS_E_NOT_SUPPORTED 0x80042400L	The volume cannot be dismounted. It does not support the operation.
VDS_E_VOLUME_PERMANENTLY_DISMOUNTED 0x8004245DL	The volume is already dismounted. It cannot be dismounted temporarily until it becomes mountable.
VDS_E_VOLUME_HAS_PATH 0x8004245EL	The volume cannot be dismounted because it still has an access path.
VDS_E_DEVICE_IN_USE 0x80042413L	The volume is in use and cannot be dismounted.

Remarks

To mount a volume, use the Mount method.

Requirements

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