IVdsVolumeMF2::FormatEx 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.]

Formats a file system volume on a partition.

Syntax

HRESULT FormatEx(
  [in]  LPWSTR    pwszFileSystemTypeName,
  [in]  USHORT    usFileSystemRevision,
  [in]  ULONG     ulDesiredUnitAllocationSize,
  [in]  LPWSTR    pwszLabel,
  [in]  BOOL      bForce,
  [in]  BOOL      bQuickFormat,
  [in]  BOOL      bEnableCompression,
  [out] IVdsAsync **ppAsync
);

Parameters

[in] pwszFileSystemTypeName

Null-terminated Unicode string containing the name of the file system with which to format the volume. This parameter can be NULL or the name of a Windows file system. The following file systems are supported: "NTFS", "FAT", "FAT32", "UDF", and "EXFAT". If this parameter is NULL, the default file system is used. For more information, see VDS_FILE_SYSTEM_FORMAT_SUPPORT_FLAG.

[in] usFileSystemRevision

The revision of the file system, if any. This member is expressed as a 16-bit binary-coded decimal number, where a decimal point is implied between the second and third digits. For example, a value of 0x0250 indicates revision 2.50.

[in] ulDesiredUnitAllocationSize

The size of the allocation unit for the file system, in bytes. The value must be a power of 2. If the value is 0, a default allocation unit determined by the file system type will be used. The allocation unit range is file system dependent.

[in] pwszLabel

Null-terminated Unicode string to assign to the new file system. The maximum label size is file system dependent.

[in] bForce

Boolean that determines whether a file system format is forced, regardless of whether the partition is in use.

[in] bQuickFormat

Boolean that determines whether a file system volume is quick-formatted. A quick format does not verify each sector on the volume.

[in] bEnableCompression

Boolean that determines whether the file system volume will be created with compression enabled.

Note  This parameter is ignored if the file system is not NTFS.
 

[out] ppAsync

Pointer to an IVdsAsync interface that upon successful completion receives the IVdsAsync interface to monitor and control this operation. Callers must release the interface received when they are done with it.

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
0x00000000L
 The file system was formatted successfully.
VDS_E_OPERATION_DENIED
0x8004240AL
 The operation is denied if the caller tries to format the system, boot, crashdump, hibernation, or pagefile volume.
VDS_E_OBJECT_STATUS_FAILED
0x80042431L
 The volume has failed.
VDS_E_PACK_OFFLINE
0x80042444L
 The pack containing the volume is not accessible. All volumes in an offline pack are inaccessible.
VDS_E_FS_NOT_DETERMINED
0x80042593L
 The default file system could not be determined.
 

In addition, the IVdsAsync interface can return the following related warnings and error codes:

Return code/value Description
VDS_E_INCOMPATIBLE_FILE_SYSTEM
0x80042425L
 The file system is incompatible.
VDS_E_INCOMPATIBLE_MEDIA
0x80042426L
 The media is incompatible.
VDS_E_ACCESS_DENIED
0x80042427L
 Access is denied.
VDS_E_MEDIA_WRITE_PROTECTED
0x80042428L
 The media is write-protected.
VDS_E_BAD_LABEL
0x80042429L
 The label is not valid.
VDS_E_CANT_QUICK_FORMAT
0x8004242AL
 The volume cannot be quick-formatted.
VDS_E_IO_ERROR
0x8004242BL
 An I/O error occurred during format.
VDS_E_VOLUME_TOO_SMALL
0x8004242CL
 The volume size is too small to format.
VDS_E_VOLUME_TOO_BIG
0x8004242DL
 The volume size is too large to format.
VDS_E_CLUSTER_SIZE_TOO_SMALL
0x8004242EL
 The cluster size is too small to allow formatting.
VDS_E_CLUSTER_SIZE_TOO_BIG
0x8004242FL
 The cluster size is too large to allow formatting.
VDS_E_CLUSTER_COUNT_BEYOND_32BITS
0x80042430L
 The number of clusters is too large to be represented as a 32-bit integer.
VDS_S_VOLUME_COMPRESS_FAILED
0x00042443L
 The file system is formatted but not compressed.
VDS_E_CANT_INVALIDATE_FVE
0x80042592L
 BitLocker encryption could not be disabled for the volume.

Remarks

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 2008 [desktop apps only]
Target Platform Windows
Header vds.h
Library Uuid.lib

See also

IVdsVolumeMF2