Changeset 15716 in vbox for trunk

Timestamp:

Dec 22, 2008 1:36:56 PM (16 years ago)

Author:

vboxsync

Message:

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

• IMouse::putMouseEvent
• IMouse::putMouseEventAbsolute

Location:

trunk/src/VBox/Main

Files:

• MouseImpl.cpp (modified) (6 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)

trunk/src/VBox/Main/MouseImpl.cpp

@@ -221 +221 @@
     if (mouseCaps & VMMDEV_MOUSEHOSTWANTSABS)
     {
-        mParent->getVMMDev()->getVMMDevPort()
-            ->pfnSetMouseCapabilities(mParent->getVMMDev()->getVMMDevPort(), uHostCaps);
+        mParent->getVMMDev()->getVMMDevPort()->pfnSetMouseCapabilities(
+            mParent->getVMMDev()->getVMMDevPort(), uHostCaps);
     }
 
@@ -235 +235 @@
     int vrc = mpDrv->pUpPort->pfnPutEvent(mpDrv->pUpPort, dx, dy, dz, fButtons);
     if (RT_FAILURE (vrc))
-        rc = setError (E_FAIL, tr ("Could not send the mouse event to the virtual mouse (%Rrc)"),
-                       vrc);
+        rc = setError (VBOX_E_IPRT_ERROR,
+            tr ("Could not send the mouse event to the virtual mouse (%Rrc)"),
+                vrc);
 
     return rc;
@@ -277 +278 @@
     if (!(mouseCaps & VMMDEV_MOUSEHOSTWANTSABS))
     {
-        mParent->getVMMDev()->getVMMDevPort()
-            ->pfnSetMouseCapabilities(mParent->getVMMDev()->getVMMDevPort(),
-                                      uHostCaps | VMMDEV_MOUSEHOSTWANTSABS);
+        mParent->getVMMDev()->getVMMDevPort()->pfnSetMouseCapabilities(
+            mParent->getVMMDev()->getVMMDevPort(),
+            uHostCaps | VMMDEV_MOUSEHOSTWANTSABS);
     }
 
@@ -296 +297 @@
 
     /*
-     * Send the absolute mouse position to the VMM device
+     * Send the absolute mouse position to the VMM device.
      */
     int vrc = mParent->getVMMDev()->getVMMDevPort()
@@ -303 +304 @@
     ComAssertRCRet (vrc, E_FAIL);
 
-    // check if the guest actually wants absolute mouse positions
+    // Check if the guest actually wants absolute mouse positions.
     if (mouseCaps & VMMDEV_MOUSEGUESTWANTSABS)
     {
@@ -317 +318 @@
                                           fButtons);
         if (RT_FAILURE (vrc))
-            rc = setError (E_FAIL, tr ("Could not send the mouse event to the virtual mouse (%Rrc)"),
-                           vrc);
+            rc = setError (VBOX_E_IPRT_ERROR,
+                tr ("Could not send the mouse event to the virtual mouse (%Rrc)"),
+                    vrc);
     }
 

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

@@ -8979 +8979 @@
         Initiates a mouse event using relative pointer movements
         along x and y axis.
+
+        <result name="E_ACCESSDENIED">
+          Console not powered up.
+        </result>
+        <result name="VBOX_E_IPRT_ERROR">
+          Could not send mouse event to virtual mouse.
+        </result>
+
       </desc>
 
@@ -9021 +9029 @@
         start from <tt>[1,1]</tt> which corresponds to the top left
         corner of the virtual display.
+
+        <result name="E_ACCESSDENIED">
+          Console not powered up.
+        </result>
+        <result name="VBOX_E_IPRT_ERROR">
+          Could not send mouse event to virtual mouse.
+        </result>
 
         <note>