Changeset 44970 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Mar 11, 2013 9:59:05 AM (12 years ago)

Author:

vboxsync

Message:

Main/VirtualBoxClient: add method to perform VM error checking which simplifies client code
com/ErrorInfo: small bugfix (the object where the error information originated was always lost), added a way to inject whole error object structures which needed the bugfix
Frontends/VBoxSDL: sample code how to use the new method

File:

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

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

@@ -18285 +18285 @@
   <interface
     name="IVirtualBoxClient" extends="$unknown"
-    uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
+    uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
     wsmap="suppress"
     >
@@ -18315 +18315 @@
     </attribute>
 
+    <method name="checkMachineError">
+      <desc>
+        Perform error checking before using an <link to="IMachine"/> object.
+        Generally useful before starting a VM and all other uses. If anything
+        is not as it should be then this method will return an appropriate
+        error.
+      </desc>
+
+      <param name="machine" type="IMachine" dir="in">
+        <desc>The machine object to check.</desc>
+      </param>
+    </method>
   </interface>