Changeset 60546 in vbox

Timestamp:

Apr 18, 2016 4:45:44 PM (9 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

106675

Message:

Main/idl: document how errors are handled when creating IVirtualBox or IVirtualBoxClient instances

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (2 diffs)
• src-client/VirtualBoxClientImpl.cpp (modified) (1 diff)

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

@@ -1880 +1880 @@
       To enumerate all the virtual machines on the host, use the
       <link to="IVirtualBox::machines"/> attribute.
+
+      Error information handling is a bit special with IVirtualBox: creating
+      an instance will always succeed. The return of the actual error
+      code/information is postponed to any attribute or method call. The
+      reason for this is that COM likes to mutilate the error code and lose
+      the detailed error information returned by instance creation.
     </desc>
 
@@ -21142 +21148 @@
       via the webservice). Once the session logic is redesigned this might
       change.
+
+      Error information handling is a bit special with IVirtualBoxClient:
+      creating an instance will always succeed. The return of the actual error
+      code/information is postponed to any attribute or method call. The
+      reason for this is that COM likes to mutilate the error code and lose
+      the detailed error information returned by instance creation.
     </desc>
 

trunk/src/VBox/Main/src-client/VirtualBoxClientImpl.cpp

@@ -138 +138 @@
     }
 
-    /* Confirm a successful initialization iwhen it's the case. Must be last,
+    /* Confirm a successful initialization when it's the case. Must be last,
      * as on failure it will uninitialize the object. */
     if (SUCCEEDED(rc))