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

Timestamp:

Oct 25, 2023 3:37:09 PM (15 months ago)

Author:

vboxsync

Message:

doc/manual,Frontends/VBoxManage,Main/{Global,GuestOSType,VirtualBox.xidl}:
Revisit the OS guest OS changes which added a new 'variant' field to the
Global::sOSTypes[] table along with a new VBoxManage subcommand and
IVirtualBox methods for accessing the guest OS variant information
(r159137). After discussion with the documentation team the identifier
'variant' is being changed to the clearer 'subtype' which also doesn't
overlap with the 'variant' terminology used with medium management
(IMedium::variant(), the MediumVariant enum, etc.). bugref:5936

File:

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

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

@@ -3530 +3530 @@
     </method>
 
-    <method name="getGuestOSVariantsByFamilyId">
+    <method name="getGuestOSSubtypesByFamilyId">
       <rest request="get" path="/server/methods/"/>
       <desc>
-        Returns a list of guest OS family variants for a corresponding
+        Returns a list of guest OS family subtypes for a corresponding
         guest OS family ID type.
 
@@ -3540 +3540 @@
         <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"/>
+        subtype is contained in the <link to="IGuestOSType::subtype"/>
         attribute.
 
@@ -3551 +3551 @@
         <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">
+      <param name="OSsubtypes" type="wstring" safearray="yes" dir="return">
+        <desc>Array of guest OS family subtypes associated with the specified guest OS family ID.</desc>
+      </param>
+    </method>
+
+    <method name="getGuestOSDescsBySubtype">
       <rest request="get" path="/server/methods/"/>
       <desc>
         Returns a list of guest OS family descriptions for a corresponding
-        guest OS family variant.
+        guest OS family subtype.
 
         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.
+        <link to="IGuestOSType::subtype"/> attribute which contains a
+        human readable description of the guest OS subtype 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>
+          @a OSSubtype is not a valid guest OS subtype.
+        </result>
+
+      </desc>
+      <param name="OSSubtype" type="wstring" dir="in">
+        <desc>Guest OS subtype.</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>
+        <desc>Array of guest OS descriptions associated with the specified guest OS subtype.</desc>
       </param>
     </method>
@@ -13579 +13579 @@
     </attribute>
 
-    <attribute name="variant" type="wstring" readonly="yes">
-      <desc>Guest OS variant string.</desc>
+    <attribute name="subtype" type="wstring" readonly="yes">
+      <desc>Guest OS subtype string.</desc>
     </attribute>