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

Timestamp:

Dec 1, 2008 4:18:38 PM (16 years ago)

Author:

vboxsync

Message:

#3285: Improve error handling API to include unique error numbers
Document

• IVirtualBox::getHardDisk2
• IVirtualBox::findHardDisk2
• IVirtualBox::openDVDImage (todo: document file not found)

File:

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

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

@@ -270 +270 @@
   <result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
     <desc>
-       Object corresponding to the supplied arguments does not exist.
+      Object corresponding to the supplied arguments does not exist.
     </desc>
   </result>
@@ -276 +276 @@
   <result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
     <desc>
-       Current virtual machine state prevents the operation.
+      Current virtual machine state prevents the operation.
     </desc>
   </result>
@@ -282 +282 @@
   <result name="VBOX_E_VM_ERROR" value="0x80BB0003">
     <desc>
-       Virtual machine error occurred attempting the operation.
+      Virtual machine error occurred attempting the operation.
     </desc>
   </result>
@@ -288 +288 @@
   <result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
     <desc>
-       File not accessible or erroneous file contents.
+      File not accessible or erroneous file contents.
     </desc>
   </result>
@@ -294 +294 @@
   <result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
     <desc>
-       Runtime subsystem error.
+      Runtime subsystem error.
     </desc>
   </result>
@@ -300 +300 @@
   <result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
     <desc>
-       Pluggable Device Manager error.
+      Pluggable Device Manager error.
     </desc>
   </result>
@@ -306 +306 @@
   <result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
     <desc>
-       Current object state prohibits operation.
+      Current object state prohibits operation.
     </desc>
   </result>
@@ -312 +312 @@
   <result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
     <desc>
-       Host operating system related error.
+      Host operating system related error.
     </desc>
   </result>
@@ -318 +318 @@
   <result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
     <desc>
-       Requested operation is not supported.
+      Requested operation is not supported.
     </desc>
   </result>
@@ -1718 +1718 @@
         <link to="#createHardDisk2()"/> or opened by <link
         to="#openHardDisk2()"/>, or attached to some known virtual machine.
+
+        <result name="VBOX_E_OBJECT_NOT_FOUND">
+          No hard disk object matching @a id found.
+        </result>
+
       </desc>
       <param name="id" type="uuid" dir="in">
@@ -1749 +1754 @@
         that on case sensitive file systems, a case sensitive comparison is
         performed, otherwise the case of symbols in the file path is ignored.
+
+        <result name="VBOX_E_OBJECT_NOT_FOUND">
+          No hard disk object matching @a location found.
+        </result>
+
       </desc>
       <param name="location" type="wstring" dir="in">
@@ -1774 +1784 @@
 
         <note>
-          Currently, only ISO CD/DVD images are supported by VirtualBox.
-        </note>
+          Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
+        </note>
+
+        <result name="VBOX_E_FILE_ERROR">
+          Image conflicts with another in the media registry.
+        </result>
+
       </desc>
       <param name="location" type="wstring" dir="in">