Changeset 22208 in vbox for trunk/src/VBox/Main

Timestamp:

Aug 12, 2009 1:47:17 PM (15 years ago)

Author:

vboxsync

Message:

Main: API docs

File:

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

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

@@ -391 +391 @@
       <!-- 2008-12-17: 2.1.0 released
            2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
-           2009-04-08: 2.2.0 released -->
+           2009-04-08: 2.2.0 released
+           VirtualBox.xml additions: NetserviceRegistry with DHCPServers
+           Machine changes: HardDiskAttachments is now StorageControllers
+      -->
     </const>
     <const name="v1_8"     value="10">
       <desc>Settings version "1.8", written by VirtualBox 3.1.x.</desc>
+      <!-- Machine additions: Display/@accelerate2DVideo
+      -->
     </const>
   </enum>
@@ -3941 +3946 @@
       be queried from the session object and then the desired settings changes
       can be applied to the returned object using IMachine attributes and
-      methods. See the ISession interface description for more information
-      about sessions.
-
-      Note that the IMachine interface does not provide methods to control
-      virtual machine execution (such as start the machine, or power it
-      down) -- these methods are grouped in a separate IConsole
-      interface. Refer to the IConsole interface description to get more
-      information about this topic.
+      methods. See the <link to="ISession"/> interface description for more
+      information about sessions.
+
+      Note that IMachine does not provide methods to control virtual machine
+      execution (such as start the machine, or power it down) -- these methods
+      are grouped in a separate interface called <link to="IConsole" />.
 
       <see>ISession, IConsole</see>
@@ -3961 +3964 @@
         Whether this virtual machine is currently accessible or not.
 
-        The machine is considered to be inaccessible when:
-        <ul>
-          <li>It is a registered virtual machine, and
-          </li>
-          <li>Its settings file is inaccessible (for example, it is
-            located on a network share that is not accessible during
-            VirtualBox startup, or becomes inaccessible later, or if
-            the settings file can be read but is invalid).
-          </li>
-        </ul>
-
-        Otherwise, the value of this property is always @c true.
+        A machine is always deemed accessible unless it is registered <i>and</i>
+        its settings file cannot be read or parsed (either because the file itself
+        is unavailable or has invalid XML contents).
 
         Every time this property is read, the accessibility state of
@@ -3978 +3972 @@
         the <link to="#accessError"/> property may be used to get the
         detailed error information describing the reason of
-        inaccessibility.
+        inaccessibility, including XML error messages.
 
         When the machine is inaccessible, only the following properties