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

Timestamp:

Oct 21, 2009 10:17:08 AM (15 years ago)

Author:

vboxsync

Message:

API: make necessary adjustments to support DVD passthrough again, together with the necessary client code changes. Unfortunately it is not possible to define the API in the ideal way due to how settings are handled in MachineImpl.cpp.

File:

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

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

@@ -4060 +4060 @@
   <interface
      name="IMachine" extends="$unknown"
-     uuid="d867a463-0f78-4ec7-a876-8da001464537"
+     uuid="db35f17a-179f-4332-91b2-a49d5cfb678c"
      wsmap="managed"
      >
@@ -4751 +4751 @@
     </method>
 
+    <method name="passthroughDevice">
+      <desc>
+        Sets the passthrough mode of an existing DVD device. Changing the
+        setting while the VM is running is forbidden. The setting is only used
+        if at VM start the device is configured as a host DVD drive, in all
+        other cases it is ignored. The device must already exist; see
+        <link to="IMachine::attachDevice"/> for how to attach a new device.
+
+        The @a controllerPort and @a device parameters specify the device slot and
+        have have the same meaning as with <link to="IMachine::attachDevice" />.
+
+        <result name="E_INVALIDARG">
+          SATA device, SATA port, IDE port or IDE slot out of range.
+        </result>
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Attempt to modify an unregistered virtual machine.
+        </result>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Invalid machine state.
+        </result>
+
+      </desc>
+      <param name="name" type="wstring" dir="in">
+        <desc>Name of the storage controller.</desc>
+      </param>
+      <param name="controllerPort" type="long" dir="in">
+        <desc>Storage controller port.</desc>
+      </param>
+      <param name="device" type="long" dir="in">
+        <desc>Device slot in the given port.</desc>
+      </param>
+      <param name="passthrough" type="boolean" dir="in">
+        <desc>New value for the passthrough setting.</desc>
+      </param>
+    </method>
+
     <method name="mountMedium">
       <desc>
@@ -8363 +8399 @@
   <interface
     name="IMediumAttachment" extends="$unknown"
-    uuid="ff554585-560a-489d-963c-cf6da6a826de"
+    uuid="7bb6ac41-8c03-4863-9eea-d9c76561b8d1"
     wsmap="struct"
   >
@@ -8400 +8436 @@
     </attribute>
 
-    <attribute name="passthrough" type="boolean" readonly="no">
+    <attribute name="passthrough" type="boolean" readonly="yes">
       <desc>Pass I/O requests through to a device on the host.</desc>
     </attribute>