[MS-VDS]: Virtual Disk Service (VDS) Protocol Specification

Return Values: The method MUST return zero or a non-error HRESULT (as specified in [MS-ERREF]) to indicate success, or return an implementation-specific nonzero error code toindicate failure. For the HRESULT values predefined by the Virtual Disk Service RemoteProtocol, see section 2.2.3.Note This method is not valid on CD/DVD or super floppy devices. These devices do notsupport partition tables.ERROR_SUCCESS (0x00000000)When the server receives this message, it MUST validate the following parameter:•Verify that ppAsync is not NULL.The server MUST perform the following:•Create a new async object implementing the IVdsAsync interface by using an output type ofVDS_ASYNCOUT_FORMAT and set the pointer that ppAsync references to the interface.•Return an HRESULT indicating failure or success. Any errors encountered up through this point inprocessing the FormatPartition operation are returned in this HRESULT.The server MUST perform the following. Errors generated in this sequence of steps are returned inthe pHrResult parameter to the IVdsAsync::Wait or IVdsAsyncQueryStatus methods.•If the operating system is unable to format the device with the file system type specified usingthe type parameter, then this method MUST return VDS_E_INCOMPATIBLE_FILE_SYSTEM.•If the target device\media is write-protected, then this method MUST returnVDS_E_MEDIA_WRITE_PROTECTED.•If the pwszLabel parameter is incompatible with the file system type specified using the typeparameter, then the server MUST return VDS_E_BAD_LABEL.•If the specified file system type has a minimum volume size requirement, and that requirement isnot met, then the server MUST return VDS_E_VOLUME_TOO_SMALL.•If the specified file system type has a maximum volume size requirement, and that requirementis not met, then the server MUST return VDS_E_VOLUME_TOO_BIG.•If the specified file system type has a minimum or maximum cluster size requirement, and thatrequirement is not met, then the server MUST return VDS_E_CLUSTER_SIZE_TOO_SMALL orVDS_E_CLUSTER_SIZE_TOO_BIG, respectively.•If the specified file system type has a maximum cluster count requirement, and that requirementis not met, then the server MUST return VDS_E_CLUSTER_COUNT_BEYOND_32BITS.The server MUST update the percentage completed value periodically during the following sequence,and send progress notifications to all clients. How often the percentage completed is updated, and atwhat point in the sequence, is implementation specific. To send progress notifications to the clients:•For each callback object registered in the list of callback objects, call the callback object'sIVdsAdviseSink::OnNotify (Opnum 3) method with a VDS_NOTIFICATION structure withthe following attributes:•objectType member is VDS_NTT_FILE_SYSTEM.[MS-VDS] — v20110610Virtual Disk Service (VDS) Protocol SpecificationCopyright © 2011 Microsoft Corporation.Release: Friday, June 10, 2011220 / 360