VirtualBox
Show
Ignore:
Timestamp:
11/14/08 17:17:20 (2 months ago)
Author:
vboxsync
Message:

Main: Added ISystemProperties::defaultHardDiskFormat.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r14107 r14224  
    13861386        the <link to="#hardDisks2"/> array. See IHardDisk2 for more details. 
    13871387 
    1388         The list of all <link to="IHardDisk2::format">storage formats</link> 
    1389         supported by this VirtualBox installation can be obtained using 
    1390         <link to="ISystemProperties::hardDiskFormats"/>. 
     1388        The list of all storage formats supported by this VirtualBox 
     1389        installation can be obtained using 
     1390        <link to="ISystemProperties::hardDiskFormats"/>. If the @a format 
     1391        attribute is empty or <tt>null</tt> then the default storage format 
     1392        specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will 
     1393        be used for creating a storage unit of the hard disk. 
    13911394 
    13921395        Note that the format of the location string is storage format specific. 
     
    13961399      <param name="format" type="wstring" dir="in"> 
    13971400        <desc> 
    1398           Storage format to use for the new hard disk. 
     1401          Idetifier of the torage format to use for the new hard disk. 
    13991402        </desc> 
    14001403      </param> 
     
    52695272     name="ISystemProperties" 
    52705273     extends="$unknown" 
    5271      uuid="c7c060a9-91af-4e74-9188-a6b15a725e49
     5274     uuid="604afeba-5963-4d12-a577-902ffb96352a
    52725275     wsmap="managed" 
    52735276     > 
     
    54155418        <see> 
    54165419          <link to="IHardDiskFormat"/>, 
     5420        </see> 
     5421      </desc> 
     5422    </attribute> 
     5423 
     5424    <attribute name="defaultHardDiskFormat" type="wstring"> 
     5425      <desc> 
     5426        Identifier of the default hard disk format used by VirtualBox. 
     5427 
     5428        The hard disk format set by this attribute is used by VirtualBox 
     5429        when the hard disk format was not specified explicitly. One example is 
     5430        <link to="IVirtualBox::createHardDisk2()"/> with the <tt>null</tt> 
     5431        format argument. A more complex example is implicit creation of 
     5432        differencing hard disks when taking a snapshot of a virtual machine: 
     5433        this operation will try to use a format of the parent hard disk first 
     5434        and if this format does not support differencing hard disks the default 
     5435        format specified by this argument will be used. 
     5436 
     5437        The list of supported hard disk formats may be obtained by the 
     5438        <link  to="#defaultHardDiskFormats"/> call. Note that the default 
     5439        hard disk format must have a capability to create differencing hard 
     5440        disks; otherwise opeartions that create hard disks implicitly may fail 
     5441        unexpectedly. 
     5442 
     5443        The initial value of this property is <tt>VDI</tt> in the current 
     5444        version of the VirtualBox product, but may change in the future. 
     5445 
     5446        <note> 
     5447          Setting this property to <tt>null</tt> will restore the 
     5448          initial value. 
     5449        </note> 
     5450 
     5451        <see> 
     5452          <link to="#hardDiskFormats"/>, 
     5453          <link to="IHardDiskFormat:id"/>, 
     5454          <link to="IVirtualBox::createHardDisk2()"/> 
    54175455        </see> 
    54185456      </desc> 

© 2008 Sun Microsystems, Inc.
ContactPrivacy policy