IVdsDiskPartitionMF2::FormatPartitionEx2 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 an existing OEM, ESP, or unknown partition. This method is identical to the IVdsDiskPartitionMF::FormatPartition method, except that formatting options are specified by using the Options parameter.

Syntax

HRESULT FormatPartitionEx2(
  ULONGLONG ullOffset,
  LPWSTR    pwszFileSystemTypeName,
  USHORT    usFileSystemRevision,
  ULONG     ulDesiredUnitAllocationSize,
  LPWSTR    pwszLabel,
  DWORD     Options,
  IVdsAsync **ppAsync
);

Parameters

ullOffset

The byte offset of the partition from the beginning of the disk. This offset must be the offset of the start of a partition.

pwszFileSystemTypeName

A NULL-terminated Unicode string containing the name of the file system with which to format the partition. Must be NULL or one of the following: "NTFS", "FAT","FAT32", "UDF", or "EXFAT". If this parameter is NULL, a default value is used. For more information, see VDS_FILE_SYSTEM_FORMAT_SUPPORT_FLAG.

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.

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.

pwszLabel

A NULL-terminated Unicode string containing the label to assign to the new file system for the partition. The maximum label size is file system dependent.

Options

A bitmask of VDS_FORMAT_OPTION_FLAGS enumeration values that specify formatting options.

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
S_OK
The volume was partitioned successfully.
VDS_E_BAD_PROVIDER_DATA
0x80042441L
A provider returned bad data.
VDS_E_DISK_REMOVEABLE
0x8004255AL
The operation is not supported on removable media.
VDS_E_FS_NOT_DETERMINED
0x80042593L
The default file system could not be determined.
VDS_E_MISSING_DISK
0x80042454L
The disk is missing.
VDS_E_OBJECT_NOT_FOUND
0x80042405L
The partition does not exist.
VDS_E_PARTITION_NOT_OEM
0x8004256FL
The operation is not supported on non-OEM partitions.
 

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

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

Requirements

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

See also

IVdsDiskPartitionMF2

VDS_FILE_SYSTEM_FORMAT_SUPPORT_FLAG

VDS_FORMAT_OPTION_FLAGS