Changeset 14700 in vbox for trunk/src/VBox/Main

Timestamp:

Nov 27, 2008 12:23:25 PM (16 years ago)

Author:

vboxsync

Message:

#3285: Improve error handling API to include unique error numbers
document createDiffStorage's E_VBOX_OBJECT_IN_USE.

Location:

trunk/src/VBox/Main

Files:

• HardDisk2Impl.cpp (modified) (4 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)

trunk/src/VBox/Main/HardDisk2Impl.cpp

@@ -1929 +1929 @@
  * As opposed to the CreateDiffStorage() method, this method doesn't try to lock
  * this hard disk for reading assuming that the caller has already done so. This
- * is used when taking an online snaopshot (where all origial hard disks are
+ * is used when taking an online snaopshot (where all original hard disks are
  * locked for writing and must remain such). Note however that if @a aWait is
  * @c false and this method returns a success then the thread started by
- * this method will* unlock the hard disk (unless it is in
+ * this method will unlock the hard disk (unless it is in
  * MediaState_LockedWrite state) so make sure the hard disk is either in
  * MediaState_LockedWrite or call #LockRead() before calling this method! If @a
@@ -1940 +1940 @@
  * If @a aProgress is not NULL but the object it points to is @c null then a new
  * progress object will be created and assigned to @a *aProgress on success,
- * otherwise the existing progress object is used. If Progress is NULL, then no
+ * otherwise the existing progress object is used. If @a aProgress is NULL, then no
  * progress object is created/used at all.
  *
@@ -1955 +1955 @@
  *                      an asynchronous thread.
  *
- * @note Locks this object and aTarget for writing.
+ * @note Locks this object and @a aTarget for writing.
  */
 HRESULT HardDisk2::createDiffStorage (ComObjPtr <HardDisk2> &aTarget,
@@ -2000 +2000 @@
             if (it->snapshotIds.size() == 0)
             {
-                return setError (E_FAIL,
+                return setError (VBOX_E_OBJECT_IN_USE,
                     tr ("Hard disk '%ls' is attached to a virtual machine "
                         "with UUID {%RTuuid}. No differencing hard disks "

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

@@ -7379 +7379 @@
 
         <result name="VBOX_E_OBJECT_IN_USE">
-          Hard disk is still attached to a virtual machine.
+          Hard disk is attached to a virtual machine.
         </result>
       </desc>
@@ -7407 +7407 @@
 
         <note>
-          The hard disk will be placed to <link to="MediaState::LockedRead"/>
+          The hard disk will be set to <link to="MediaState::LockedRead"/>
           state for the duration of this operation.
         </note>
-      </desc> <param name="target" type="IHardDisk2" dir="in">
+        <result name="VBOX_E_OBJECT_IN_USE">
+          Hard disk not in NotCreated state.
+        </result>
+      </desc>
+      <param name="target" type="IHardDisk2" dir="in">
         <desc>Target hard disk.</desc>
       </param>