Changeset 14843 in vbox for trunk/src

Timestamp:

Dec 1, 2008 10:05:21 AM (16 years ago)

Author:

vboxsync

Message:

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

• IConsole::getDeviceActivity
• IConsole::attachUSBDevice
• IConsole::detachUSBDevice

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (4 diffs)
• idl/VirtualBox.xidl (modified) (3 diffs)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -2022 +2022 @@
     if (mMachineState != MachineState_Running &&
         mMachineState != MachineState_Paused)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot attach a USB device to the machine which is not running "
                 "(machine state: %d)"), mMachineState);
@@ -2034 +2034 @@
     int vrc = PDMR3QueryLun (mpVM, "usb-ohci", 0, 0, &pBase);
     if (VBOX_FAILURE (vrc))
-        return setError (E_FAIL,
+        return setError (VBOX_E_PDM_ERROR,
             tr ("The virtual machine does not have a USB controller"));
 
@@ -2048 +2048 @@
 
 #else   /* !VBOX_WITH_USB */
-    return setError (E_FAIL,
+    return setError (VBOX_E_PDM_ERROR,
         tr ("The virtual machine does not have a USB controller"));
 #endif  /* !VBOX_WITH_USB */
@@ -2109 +2109 @@
 
 #else   /* !VBOX_WITH_USB */
-    return setError (E_INVALIDARG,
-        tr ("USB device with UUID {%RTuuid} is not attached to this machine"),
-        Guid (aId).raw());
+    return setError (VBOX_E_PDM_ERROR,
+        tr ("The virtual machine does not have a USB controller"));
 #endif  /* !VBOX_WITH_USB */
 }

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

@@ -4828 +4828 @@
       <desc>
         Gets the current activity type of a given device or device group.
+        <result name="E_INVALIDARG">
+          Invalid device type.
+        </result>
       </desc>
       <param name="type" type="DeviceType" dir="in"/>
@@ -4849 +4852 @@
 
         <see>IUSBController::deviceFilters, USBDeviceState</see>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine state neither Running nor Paused.
+        </result>
+        <result name="VBOX_E_PDM_ERROR">
+          Virtual machine does not have a USB controller.
+        </result>
       </desc>
       <param name="id" type="uuid" dir="in">
@@ -4866 +4875 @@
 
         <see>IUSBController::deviceFilters, USBDeviceState</see>
+
+        <result name="VBOX_E_PDM_ERROR">
+          Virtual machine does not have a USB controller.
+        </result>
+        <result name="E_INVALIDARG">
+          USB device not attached to this virtual machine.
+        </result>
       </desc>
       <param name="id" type="uuid" dir="in">