3.2.4.4.1.31 IVolumeClient::DeleteVolume (Opnum 35)

The DeleteVolume method deletes the specified dynamic volume. This is a synchronous task.

 HRESULT DeleteVolume(
   [in] LdmObjectId volumeId,
   [in] boolean force,
   [in] hyper volumeLastKnownState,
   [out] TASK_INFO* tinfo
 );

volumeId: Specifies the OID of the volume to delete.

force: A value that indicates whether deletion of the volume will be forced if the volume is in use by another application. If this value is false, the call will fail if some other application has the volume locked.

Value	Meaning
FALSE 0	Deletion will not be forced if the volume is in use.
TRUE 1	Deletion will be forced.

volumeLastKnownState: Volume's last known modification sequence number.

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).

Upon receiving this message, the server MUST validate parameters:

1. Verify that the dynamic volume specified by volumeId is in the list of storage objects, and check whether volumeLastKnownState matches the LastKnownState field of the object.

2. Verify that tinfo is not NULL.

If parameter validation fails, the server MUST fail the operation immediately, returning an appropriate error as its response to the client.

Otherwise, the server MUST process the message as follows:

1. Attempt to delete the dynamic volume specified by volumeId, as specified by the force parameter.

2. Wait for the volume deletion to either succeed or fail.

3. Fill in the tinfo output parameter.

   TASK_INFO member	Required for this operation
   TASK_INFO::id	Required.
   TASK_INFO::storageId	Not required.
   TASK_INFO::createTime	Not required.<110>
   TASK_INFO::clientID	Not required.<111>
   TASK_INFO::percentComplete	Required for any task that returns REQ_IN_PROGRESS.
   TASK_INFO::status	Required.
   TASK_INFO::type	Required if PercentageComplete is being used.
   TASK_INFO::error	Required.
   TASK_INFO::tflag	Not required.<112>

4. Return a response to the client that contains tinfo and the status of the operation.

5. Send the task completion notification.

If the operation is successful, the server MUST make the following changes to the list of storage objects before returning the response:

1. Delete the dynamic volume object.

2. Modify the disks where the volume resided to account for the change in region allocation.

3. Delete the disk region objects that correspond to the volume.

4. Create new free region objects, or modify adjacent free region objects, to account for the free space created by the deletion.<113>

5. Modify the drive letter object associated with the volume to mark it as free.

6. Delete the file system object associated with the volume.<114>