3.2.4.4.3.23 IVolumeClient3::Format (Opnum 26)

The Format method formats the specified volume, partition, or logical drive with a file system.

 HRESULT Format(
   [in] LdmObjectId storageId,
   [in] FILE_SYSTEM_INFO fsSpec,
   [in] boolean quickFormat,
   [in] boolean force,
   [in] hyper storageLastKnownState,
   [out] TASK_INFO* tinfo
 );

storageId: Specifies the object identifier of the volume, partition, or logical drive on which the new file system is being created.

fsSpec: A FILE_SYSTEM_INFO structure that specifies details about the file system being created.

quickFormat: Boolean value that indicates if the file system will be fully formatted. This call will fail if this flag is not set and some other application has the volume locked.

Value	Meaning
FALSE 0	File system will be fully formatted. Full format requires verifying the accessibility of all sectors on the volume.
TRUE 1	File system will be quickly formatted.

force: Boolean value that indicates if the file system will be formatted if the volume, partition, or logical drive cannot be locked.

Value	Meaning
FALSE 0	File system will not be formatted unless its underlying storage can be locked.
TRUE 1	File system will be formatted regardless of whether the underlying volume, partition, or logical drive can be locked or not.

storageLastKnownState: Last known modification sequence number of the volume, partition, or logical drive on which the file system is being created.

tinfo: Pointer to a TASK_INFO structure that the client can use to track the request's progress.

Return Values: The method MUST return 0 or a nonerror HRESULT on success, or an implementation-specific nonzero error code on failure (as specified in [MS-ERREF]; see also section 2.2.1 for HRESULT values predefined by the Disk Management Remote Protocol).

When the server receives an IVolumeClient3::Format message, it MUST process that message, as specified in IVolumeClient::Format (section 3.2.4.4.1.23).