Changeset 54445 in vbox

Timestamp:

Feb 24, 2015 12:56:25 PM (10 years ago)

Author:

vboxsync

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

98548

Message:

doc/SDK: update for IVirtualBox::createMedium API change

File:

• trunk/doc/manual/en_US/SDKRef.xml (modified) (3 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -2478 +2478 @@
 
         # Call VirtualBox API, using context's fields
-        hdd = ctx['vb'].createHardDisk(format, loc)
+        hdd = ctx['vb'].createMedium(format, loc, ctx['global'].constants.AccessMode_ReadWrite, \
+                                     ctx['global'].constants.DeviceType_HardDisk)
         # Access constants using ctx['global'].constants
         progress = hdd.createBaseStorage(size, (ctx['global'].constants.MediumVariant_Standard, ))
@@ -3855 +3856 @@
 
       <itemizedlist>
+        <listitem>
+          <para>The method <xref linkend="IVirtualBox__createMedium"
+          xreflabel="IVirtualBox::createMedium()" /> replaces
+          <computeroutput>VirtualBox::createHardDisk()</computeroutput>.
+          Adjusting existing code needs adding two parameters with
+          value <computeroutput>AccessMode_ReadWrite</computeroutput>
+          and <computeroutput>DeviceType_HardDisk</computeroutput>
+          respectively. The new method supports creating floppy and
+          DVD images, and (less obviously) further API functionality
+          such as cloning floppy images.</para>
+        </listitem>
+
         <listitem><para>Drag'n drop APIs were changed as follows:<itemizedlist>
 
@@ -4591 +4604 @@
           <itemizedlist>
               <listitem>
-                <para>Neither <xref linkend="IVirtualBox__createHardDisk"
-                xreflabel="IVirtualBox::createHardDisk()" /> nor <xref
-                linkend="IVirtualBox__openMedium"
+                <para>Neither
+                <computeroutput>IVirtualBox::createHardDisk()</computeroutput>
+                nor <xref linkend="IVirtualBox__openMedium"
                 xreflabel="IVirtualBox::openMedium()" /> register media
                 automatically any more.</para>