Changeset 15849 in vbox for trunk/src/VBox

Timestamp:

Jan 8, 2009 9:54:34 AM (16 years ago)

Author:

vboxsync

Message:

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

• ISATAController::GetIDEEmulationPort
• ISATAController::SetIDEEmulationPort

File:

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

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

@@ -11643 +11643 @@
 
     <method name="GetIDEEmulationPort">
-      <desc>Gets the corresponding port number which is emulated as an IDE device.</desc>
+      <desc>
+        Gets the corresponding port number which is emulated as an IDE device.
+
+        <result name="E_INVALIDARG">
+          The @a devicePosition is not in the range 0 to 3.
+        </result>
+
+      </desc>
       <param name="devicePosition" type="long" dir="in"/>
       <param name="portNumber" type="long" dir="return"/>
@@ -11649 +11656 @@
 
     <method name="SetIDEEmulationPort">
-      <desc>Sets the port number which is emulated as an IDE device.</desc>
+      <desc>
+        Sets the port number which is emulated as an IDE device.
+
+        <result name="E_INVALIDARG">
+          The @a devicePosition is not in the range 0 to 3 or the
+          @a portNumber is not in the range 0 to 29.
+        </result>
+
+      </desc>
       <param name="devicePosition" type="long" dir="in"/>
       <param name="portNumber" type="long" dir="in"/>