Changeset 15715 in vbox for trunk

Timestamp:

Dec 22, 2008 1:15:30 PM (16 years ago)

Author:

vboxsync

Message:

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

• IKeyboard::putScancode
• IKeyboard::putScancodes
• IKeyboard::putCAD

Location:

trunk/src/VBox/Main

Files:

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

trunk/src/VBox/Main/KeyboardImpl.cpp

@@ -144 +144 @@
 
     if (RT_FAILURE (vrc))
-        rc = setError (E_FAIL, tr ("Could not send scan code 0x%08X to the virtual keyboard (%Rrc)"),
-                       scancode, vrc);
+        rc = setError (VBOX_E_IPRT_ERROR,
+            tr ("Could not send scan code 0x%08X to the virtual keyboard (%Rrc)"),
+                scancode, vrc);
 
     return rc;
@@ -182 +183 @@
 
     if (RT_FAILURE (vrc))
-        return setError (E_FAIL, tr ("Could not send all scan codes to the virtual keyboard (%Rrc)"),
-                         vrc);
+        return setError (VBOX_E_IPRT_ERROR,
+            tr ("Could not send all scan codes to the virtual keyboard (%Rrc)"),
+                vrc);
 
     /// @todo is it actually possible that not all scancodes can be transmitted?

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

@@ -8884 +8884 @@
       in <link to="IConsole::keyboard"/>.
 
-      Through this interface, the virtual machine's virtual keyboard can be controlled. One
-      can send keystrokes to the virtual machine and send the Ctrl-Alt-Del sequence to it.
+      Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
+      to the virtual machine.
+
     </desc>
     <method name="putScancode">
-      <desc>Sends a scancode to the keyboard.</desc>
+      <desc>Sends a scancode to the keyboard.
+
+        <result name="VBOX_E_IPRT_ERROR">
+          Could not send scan code to virtual keyboard.
+        </result>
+
+      </desc>
       <param name="scancode" type="long" dir="in"/>
     </method>
 
     <method name="putScancodes">
-      <desc>Sends an array of scancode to the keyboard.</desc>
+      <desc>Sends an array of scancodes to the keyboard.
+
+        <result name="VBOX_E_IPRT_ERROR">
+          Could not send all scan codes to virtual keyboard.
+        </result>
+
+      </desc>
       <param name="scancodes" type="long" dir="in" safearray="yes"/>
       <param name="codesStored" type="unsigned long" dir="return"/>
@@ -8899 +8912 @@
 
     <method name="putCAD">
-      <desc>Sends the Ctrl-Alt-Del sequence to the keyboard.</desc>
+      <desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
+      function is nothing special, it is just a convenience function
+      calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
+
+        <result name="VBOX_E_IPRT_ERROR">
+          Could not send all scan codes to virtual keyboard.
+        </result>
+
+      </desc>
     </method>