Changeset 44649 in vbox

Timestamp:

Feb 12, 2013 12:18:13 PM (12 years ago)

Author:

vboxsync

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

83740

Message:

Documentation: added new paragraphs into chapter "Incompatible API changes with version 4.3". Fixed python script vboxshell.py. Fixed python example inside SDK documentation. PR5434.

Location:

trunk

Files:

• doc/manual/en_US/SDKRef.xml (modified) (2 diffs)
• src/VBox/Frontends/VBoxShell/vboxshell.py (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -2246 +2246 @@
         hdd = ctx['vb'].createHardDisk(format, loc)
         # Access constants using ctx['global'].constants
-        progress = hdd.createBaseStorage(size, ctx['global'].constants.HardDiskVariant_Standard)
+        progress = hdd.createBaseStorage(size, (ctx['global'].constants.MediumVariant_Standard, ))
         # use standard progress bar mechanism
         ctx['progressBar'](progress)
@@ -3530 +3530 @@
       <itemizedlist>
         <listitem>
+          <para>Medium management APIs were changed as follows:<itemizedlist>
+
+            <listitem>
+              <para>The type of attribute
+              <computeroutput>IMedium::variant</computeroutput>
+              changed from <computeroutput>unsigned long</computeroutput>
+              to <computeroutput>safe-array MediumVariant</computeroutput>.
+              It is an array of flags instead of a set of flags which were stored inside one variable.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>The parameter list for <xref
+              linkend="IMedium__cloneTo"
+              xreflabel="IMedium::cloneTo()" /> was modified.</para>
+              The type of parameter variant was changed from unsigned long to safe-array MediumVariant.
+            </listitem>
+
+            <listitem>
+              <para>The parameter list for <xref
+              linkend="IMedium__createBaseStorage"
+              xreflabel="IMedium::createBaseStorage()" /> was modified.</para>
+              The type of parameter variant was changed from unsigned long to safe-array MediumVariant.
+            </listitem>
+
+            <listitem>
+              <para>The parameter list for <xref
+              linkend="IMedium__createDiffStorage"
+              xreflabel="IMedium::createDiffStorage()" /> was modified.</para>
+              The type of parameter variant was changed from unsigned long to safe-array MediumVariant.
+            </listitem>
+
+            <listitem>
+              <para>The parameter list for <xref
+              linkend="IMedium__cloneToBase"
+              xreflabel="IMedium::cloneToBase()" /> was modified.</para>
+              The type of parameter variant was changed from unsigned long to safe-array MediumVariant.
+            </listitem>
+          </itemizedlist></para>
+        </listitem>
+
+        <listitem>
+          <para>The type of attribute
+          <computeroutput>IMediumFormat::capabilities</computeroutput>
+          changed from <computeroutput>unsigned long</computeroutput>
+          to <computeroutput>safe-array MediumFormatCapabilities</computeroutput>.
+          It is an array of flags instead of a set of flags which were stored inside one variable.
+          </para>
+        </listitem>
+
+        <listitem>
           <para>The attribute <xref linkend="IMedium__logicalSize"
           xreflabel="IMedium::logicalSize()" /> now returns the logical

trunk/src/VBox/Frontends/VBoxShell/vboxshell.py

@@ -2150 +2150 @@
 
    hdd = ctx['vb'].createHardDisk(format, loc)
-   progress = hdd.createBaseStorage(size, ctx['global'].constants.MediumVariant_Standard)
+   progress = hdd.createBaseStorage(size, (ctx['global'].constants.MediumVariant_Standard, ))
    if progressBar(ctx,progress) and hdd.id:
        print "created HDD at %s as %s" %(colPath(ctx,hdd.location), hdd.id)

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

@@ -12247 +12247 @@
       <desc>
         Returns the storage format variant information for this medium
-        as a combination of the flags described at <link to="MediumVariant" />.
+        as an aaray of the flags described at <link to="MediumVariant" />.
         Before <link to="#refreshState"/> is called this method returns
         an undefined value.
@@ -13462 +13462 @@
     <attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
       <desc>
-        Capabilities of the format as a set of bit flags.
+        Capabilities of the format as an array of the flags.
 
         For the meaning of individual capability flags see