Changeset 71349 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Mar 15, 2018 11:23:39 AM (7 years ago)

Author:

vboxsync

Message:

Guest Control/Main: Added (COM) error codes VERR_GSTCTL_MAX_OBJECTS_REACHED, VBOX_E_MAXIMUM_REACHED and VBOX_E_GSTCTL_GUEST_ERROR; make use of those when creating guest control objects, such as guest sessions, files and directories.

File:

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

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

@@ -432 +432 @@
     <desc>
       A provided password was incorrect.
+    </desc>
+  </result>
+
+  <result name="VBOX_E_MAXIMUM_REACHED" value="0x80BB000E">
+    <desc>
+      A maximum has been reached.
+    </desc>
+  </result>
+
+  <result name="VBOX_E_GSTCTL_GUEST_ERROR" value="0x80BB000F">
+    <desc>
+      Guest Control reported an error from the guest side.
     </desc>
   </result>
@@ -11882 +11894 @@
 
       There can be up to 2048 objects (guest processes, files and directories)
-      a time per guest session.  Exceeding the limit will result in an error.
-<!-- @todo r=bird: Add specific VBOX_E_XXX error for this and document it here! -->
+      a time per guest session.  Exceeding the limit will result in an error (see
+      the corresponding functions for more).
 
       When done with either of these objects, including the guest session itself,
@@ -12206 +12218 @@
           Error while opening the directory.
         </result>
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest directories has been reached.
+        </result>
       </desc>
       <param name="path" type="wstring" dir="in">
@@ -12513 +12528 @@
           Error while opening the file.
         </result>
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest files has been reached.
+        </result>
       </desc>
       <param name="path" type="wstring" dir="in">
@@ -12795 +12813 @@
         <result name="VBOX_E_IPRT_ERROR">
           Error creating guest process.
+        </result>
+
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest processes has been reached.
         </result>
       </desc>
@@ -13921 +13943 @@
 
         There can be a maximum of 32 sessions at once per VM.  An error will
-        be returned if this has been reached. <!-- This should actually read:
-        VBOX_E_IPRT_ERROR will be return if this limit has been reached.
-        However, keep in mind that VBOX_E_IPRT_ERROR can be returned for about
-        88 unrelated reasons, so you don't know what happend unless you parse
-        the error text. (bird) -->
-<!-- @todo r=bird: Seriously, add an dedicated VBOX_E_MAX_GUEST_SESSIONS status
-for this condition.  Do the same for all other maximums and things that could be
-useful to the API client. -->
+        be returned if this has been reached.
 
         For more information please consult <link to="IGuestSession"/>
+
+        <result name="VBOX_E_IPRT_ERROR">
+          Error creating guest session.
+        </result>
+
+        <result name="VBOX_E_MAXIMUM_REACHED">
+          The maximum of concurrent guest sessions has been reached.
+        </result>
       </desc>
       <param name="user" type="wstring" dir="in">