IVdsVolumeMF3::FormatEx2 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 volume on a partition. This method is identical to the IVdsVolumeMF2::FormatEx method, except that formatting options are specified by using the Options parameter.
Syntax
HRESULT FormatEx2(
[in] LPWSTR pwszFileSystemTypeName,
[in] USHORT usFileSystemRevision,
[in] ULONG ulDesiredUnitAllocationSize,
[in] LPWSTR pwszLabel,
[in] DWORD Options,
[out] IVdsAsync **ppAsync
);
Parameters
[in] pwszFileSystemTypeName
A 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
A null-terminated Unicode string to assign to the new file system. The maximum label size is file system dependent.
[in] Options
A bitmask of VDS_FORMAT_OPTION_FLAGS enumeration values that specify formatting options.
[out] ppAsync
A 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 |
|---|---|
|
The file system was formatted successfully. |
|
The operation is denied if the caller tries to format the system, boot, crashdump, hibernation, or pagefile volume. |
|
The volume has failed. |
|
The pack containing the volume is not accessible. All volumes in an offline pack are inaccessible. |
|
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 |
|---|---|
|
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 I/O 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 be represented as a 32-bit integer. |
|
The file system is formatted but not compressed. |
|
BitLocker encryption could not be disabled for the volume. |
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 |