Changeset 20945 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Jun 25, 2009 2:34:57 PM (16 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

49120

Message:

API/HardDisk: allow cloning to existing images. just a stub for now.

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -9607 +9607 @@
         </note>
         <result name="VBOX_E_OBJECT_IN_USE">
-          Hard disk not in NotCreated state.
+          Hard disk not in @c NotCreated state.
         </result>
       </desc>
@@ -9708 +9708 @@
         location defined by the @a target argument.
 
-        The target hard disk must be in <link to="MediaState_NotCreated"/>
-        state (i.e. must not have an existing storage unit). Upon successful
-        completion, the cloned hard disk will contain exactly the same sector
-        data as the hard disk being cloned, except that a new UUID for the
-        clone will be randomly generated.
+        The target hard disk must be either in <link to="MediaState_NotCreated"/>
+        state (i.e. must not have an existing storage unit) or in
+        <link to="MediaState_Created"/> state (i.e. created and not locked, and
+        big enough to hold the data or else the copy will be partial). Upon
+        successful completion, the cloned hard disk will contain exactly the
+        same sector data as the hard disk being cloned, except that in the
+        first case a new UUID for the clone will be randomly generated, and in
+        the second case the UUID will remain unchanged.
 
         The @a parent argument defines which hard disk will be the parent
@@ -9729 +9732 @@
           state for the duration of this operation.
         </note>
+        <result name="E_NOTIMPL">
+          The specified cloning variant is not supported at the moment.
+        </result>
       </desc>
       <param name="target" type="IHardDisk" dir="in">