IVdsVolumeMF::Format method (vds.h)
[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]
Formats a file system on the current volume.
Syntax
HRESULT Format(
[in] VDS_FILE_SYSTEM_TYPE type,
[in] LPWSTR pwszLabel,
[in] DWORD dwUnitAllocationSize,
[in] BOOL bForce,
[in] BOOL bQuickFormat,
[in] BOOL bEnableCompression,
[out] IVdsAsync **ppAsync
);
Parameters
[in] type
A VDS_FILE_SYSTEM_TYPE enumeration value that specifies the file system to be used. Must be one of the following: VDS_FST_NTFS, VDS_FST_FAT, VDS_FST_FAT32, or VDS_FST_UDF.
[in] pwszLabel
A string representing the file system label.
[in] dwUnitAllocationSize
The size of the allocation unit for the file system in bytes, which is usually between 512 and 65536.
[in] bForce
If TRUE, the file system is formatted unconditionally even while in use; otherwise, the operation fails.
[in] bQuickFormat
If TRUE, VDS performs a quick format (it does not verify each sector on the volume).
[in] bEnableCompression
If TRUE, compression is enabled on the newly formatted file system. Compression is a feature of NTFS, and is ignored for FAT and FAT32.
[out] ppAsync
The address of an IVdsAsync interface pointer, which VDS initializes on return. Callers must release the interface. Use this pointer to cancel, wait for, or query the status of the operation.
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 |
|---|---|
|
The file system was formatted successfully. |
|
The operation is denied if the caller tries to format the system, boot, crashdump, hibernation, or pagefile volumes. |
|
The volume has failed. |
|
The pack containing the volume is not accessible. All volumes in an offline pack are inaccessible. |
In addition, the IVdsAsync interface can return the following related warnings and error codes.
| Return code/value | Description |
|---|---|
|
The file system is formatted but not compressed. |
|
The file system is incompatible. |
|
The media is incompatible. |
|
Access is denied. |
|
The media is write-protected. |
|
The label is not valid. |
|
The volume cannot be quick formatted. |
|
An IO error occurred during format. |
|
The volume size is too small to format. |
|
The volume size is too large to format. |
|
The cluster size is too small to allow formatting. |
|
The cluster size is too large to allow formatting. |
|
The number of clusters is too large to represent as a 32-bit integer. |
|
The value of the type parameter was not VDS_FST_NTFS, VDS_FST_FAT, VDS_FST_FAT32, or VDS_FST_UDF. |
|
BitLocker encryption could not be disabled for the volume. |
Remarks
To create a boot volume on a dynamic disk, you must call IVdsVolume::SetFlags to set the VDS_VF_INSTALLABLE flag before calling Format to format the volume.
If an OEM partition is formatted as FAT or FAT32, the partition type does not change. If it is formatted with NTFS, the partition type changes to PARTITION_IFS (0x07). For information about partition types, see CREATE_PARTITION_PARAMETERS.
If this method is called for a volume that is protected by BitLocker full-volume encryption, BitLocker encryption is disabled for the volume until the user re-enables it.
For more information about file system limits such as minimum and maximum allocation unit size (also called cluster size), see NTFS Technical Reference and FAT Technical Reference.
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 |