Changeset 20842 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Jun 23, 2009 2:48:10 PM (16 years ago)

Author:

vboxsync

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

48981

Message:

API and Frontends: change IVirtualBox::openHardDisk to allow modifying the image UUID and parent UUID on open

File:

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

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

@@ -1903 +1903 @@
     <method name="openHardDisk">
       <desc>
-        Opens a hard disk from an existing location.
+        Opens a hard disk from an existing location, optionally replacing
+        the image UUID and/or parent UUID.
 
         After the hard disk is successfully opened by this method, it gets
@@ -1954 +1955 @@
           <desc>
               Determines whether to open the image in read/write or read-only mode.
+          </desc>
+      </param>
+      <param name="setImageId" type="boolean" dir="in">
+          <desc>
+              Select whether a new image UUID is set or not.
+          </desc>
+      </param>
+      <param name="imageId" type="wstring" dir="in">
+          <desc>
+              New UUID for the image. If an empty string is passed, then a new
+              UUID is automatically created. Specifying a zero UUIDs is not valid.
+          </desc>
+      </param>
+      <param name="setParentId" type="boolean" dir="in">
+          <desc>
+              Select whether a new parent UUID is set or not.
+          </desc>
+      </param>
+      <param name="parentId" type="wstring" dir="in">
+          <desc>
+              New parent UUID for the image. If an empty string is passed, then a
+              new UUID is automatically created, provided @a setParentId is
+              @c true. A zero UUID is valid.
           </desc>
       </param>