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

3.4.5.2.33.3 IVdsVolumeMF2::FormatEx (Opnum 5)The FormatEx method formats a file system on a volume.HRESULT FormatEx([in, unique, string] WCHAR* pwszFileSystemTypeName,[in] unsigned short usFileSystemRevision,[in] unsigned long ulDesiredUnitAllocationSize,[in, unique, string] WCHAR* pwszLabel,[in] long bForce,[in] long bQuickFormat,[in] long bEnableCompression,[out] IVdsAsync** ppAsync);pwszFileSystemTypeName: A null-terminated Unicode string that contains the name of the filesystems to format the volume with.usFileSystemRevision: A 16-bit, binary-coded decimal number that indicates the revision of thefile system, if any. The first two (most significant) digits (8-bits) indicate the major revision,and the last two (least significant) digits (8-bits) indicate the minor revision.Note 0x0250 represents revision 2.50.ulDesiredUnitAllocationSize: The size, in bytes, of the allocation unit for the file system. Thevalue MUST be a power of 2. If the value is 0, a default allocation unit that is determined bythe file system type is used. The allocation unit range is file system-dependent.pwszLabel: A null-terminated Unicode string to assign to the new file system. The maximumlabel size is file system-dependent.bForce: A Boolean that determines whether a file system format is forced, even if the volume isin use.bQuickFormat: A Boolean that determines whether a file system is quick formatted. A quickformat does not verify each sector on the volume.bEnableCompression: A Boolean that determines whether a file system is created withcompression enabled.ppAsync: A pointer to an IVdsAsync interface that, if the operation is successfully completed,receives the IVdsAsync interface to monitor and control this operation. Callers MUST releasethe interface when they are done with it.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.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 that implements the IVdsAsync interface with an output type ofVDS_ASYNCOUT_FORMAT and then set the pointer that ppAsync references to the interface.[MS-VDS] — v20110610Virtual Disk Service (VDS) Protocol SpecificationCopyright © 2011 Microsoft Corporation.Release: Friday, June 10, 2011257 / 360