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

Timestamp:

Sep 19, 2023 10:01:39 AM (20 months ago)

Author:

vboxsync

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

159137

Message:

doc/manual,Frontends/VBoxManage,Main/{Global,GuestOSType,VirtualBox.xidl}:
Extend the OSType struct by including a new element named 'variant'
to provide further guest OS details and aid in guest OS categorization
for the GUI when creating VMs. Populate this field in the
Global::sOSTypes[] table for Linux using the distro name and for BSD
using the BSD flavour. Include the variant information in 'VBoxManage
list ostypes' and add a new 'VBoxManage list osvariants' subcommand.
Add new IVirtualBox methods for accessing the guest OS variant
information: getGuestOSVariantsByFamilyId() and getGuestOSDescsByVariant().
bugref:5936

File:

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

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

@@ -2700 +2700 @@
   <interface
     name="IVirtualBox" extends="$unknown"
-    uuid="0f22e6d1-07f5-4168-b3ef-167c57670c17"
+    uuid="901ac662-0b6e-4b19-a0ac-21cb54d4d5b2"
     wsmap="managed"
     rest="managed"
@@ -3491 +3491 @@
       <param name="type" type="IGuestOSType" dir="return">
         <desc>Guest OS type object.</desc>
+      </param>
+    </method>
+
+    <method name="getGuestOSFamilies">
+      <rest request="get" path="/server/methods/"/>
+      <desc>
+        Returns a list of all known guest OS family IDs.
+
+        The <link to="IVirtualBox::guestOSTypes"/> collection contains all
+        available guest OS type objects. Each object has an
+        <link to="IGuestOSType::familyId"/> attribute which contains
+        the guest OS family identifier string that this object describes.
+
+      </desc>
+      <param name="guestOSFamilies" type="wstring" safearray="yes" dir="return">
+        <desc>Array of all known guest OS family IDs.</desc>
+      </param>
+    </method>
+
+    <method name="getGuestOSVariantsByFamilyId">
+      <rest request="get" path="/server/methods/"/>
+      <desc>
+        Returns a list of guest OS family variants for a corresponding
+        guest OS family ID type.
+
+        The <link to="IVirtualBox::guestOSTypes"/> collection contains all
+        available guest OS type objects. Each object has an
+        <link to="IGuestOSType::familyId"/> attribute which contains a
+        the guest OS family this object describes.  The guest OS family
+        variant is contained in the <link to="IGuestOSType::variant"/>
+        attribute.
+
+        <result name="E_INVALIDARG">
+          @a family is not a valid guest OS family identifier.
+        </result>
+
+      </desc>
+      <param name="family" type="wstring" dir="in">
+        <desc>Guest OS type ID string.</desc>
+      </param>
+      <param name="OSvariants" type="wstring" safearray="yes" dir="return">
+        <desc>Array of guest OS family variants associated with the specified guest OS family ID.</desc>
+      </param>
+    </method>
+
+    <method name="getGuestOSDescsByVariant">
+      <rest request="get" path="/server/methods/"/>
+      <desc>
+        Returns a list of guest OS family descriptions for a corresponding
+        guest OS family variant.
+
+        The <link to="IVirtualBox::guestOSTypes"/> collection contains all
+        available guest OS type objects. Each object has an
+        <link to="IGuestOSType::variant"/> attribute which contains a
+        human readable description of the guest OS variant this object describes.
+        The guest OS family description is contained in the
+        <link to="IGuestOSType::familyDescription"/> attribute.
+
+        <result name="E_INVALIDARG">
+          @a OSVariant is not a valid guest OS variant.
+        </result>
+
+      </desc>
+      <param name="OSVariant" type="wstring" dir="in">
+        <desc>Guest OS variant.</desc>
+      </param>
+      <param name="GuestOSDescs" type="wstring" safearray="yes" dir="return">
+        <desc>Array of guest OS descriptions associated with the specified guest OS variant.</desc>
       </param>
     </method>
@@ -13447 +13515 @@
   <interface
     name="IGuestOSType" extends="$unknown"
-    uuid="966303d0-36a8-4180-8971-18650b0d1055"
+    uuid="858fc38e-efe6-47d0-b6ac-c71023f9d043"
     wsmap="struct"
     rest="managed"
@@ -13466 +13534 @@
     <attribute name="id" type="wstring" readonly="yes">
       <desc>Guest OS identifier string.</desc>
+    </attribute>
+
+    <attribute name="variant" type="wstring" readonly="yes">
+      <desc>Guest OS variant string.</desc>
     </attribute>