Changeset 5115 in vbox

Timestamp:

Oct 1, 2007 8:32:57 AM (18 years ago)

Author:

vboxsync

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

24970

Message:

Main: CustomHardDisk wording.

Location:

trunk/src/VBox/Main

Files:

• HardDiskImpl.cpp (modified) (9 diffs)
• idl/VirtualBox.xidl (modified) (6 diffs)

trunk/src/VBox/Main/HardDiskImpl.cpp

@@ -1064 +1064 @@
     storageTypes[] =
     {
+        /* try the plugin format first if there is no extension match */
+        { HardDiskStorageType_CustomHardDisk, NULL },
+        /* then try the rest */
         { HardDiskStorageType_VMDKImage, ".vmdk" },
         { HardDiskStorageType_VirtualDiskImage, ".vdi" },
@@ -1076 +1079 @@
     for (size_t i = 0; i < ELEMENTS (storageTypes); ++ i)
     {
-        if (RTPathCompare (ext, storageTypes [i].ext) == 0)
+        if (storageTypes [i].ext &&
+            RTPathCompare (ext, storageTypes [i].ext) == 0)
         {
             first = i;
@@ -1088 +1092 @@
     HRESULT firstRC = S_OK;
     com::ErrorInfoKeeper firstErr (true /* aIsNull */);
-
-    if (haveFirst == false)
-    {
-        /* Try if a plugin supports this format. */
-        ComObjPtr <HCustomHardDisk> obj;
-        obj.createObject();
-        rc = obj->init (aVirtualBox, NULL, aLocation,
-                        FALSE /* aRegistered */);
-        if (SUCCEEDED (rc))
-        {
-            hardDisk = obj;
-            return rc;
-        }
-    }
 
     for (size_t i = 0; i < ELEMENTS (storageTypes); ++ i)
@@ -1134 +1124 @@
                 break;
             }
+            case HardDiskStorageType_CustomHardDisk:
+            {
+                ComObjPtr <HCustomHardDisk> obj;
+                obj.createObject();
+                rc = obj->init (aVirtualBox, NULL, aLocation,
+                                FALSE /* aRegistered */);
+                if (SUCCEEDED (rc))
+                {
+                    hardDisk = obj;
+                    return rc;
+                }
+                break;
+            }
             default:
             {
@@ -1594 +1597 @@
     CHECK_BUSY_AND_READERS();
 
-    // append the default path if only a name is given
+    /* append the default path if only a name is given */
     Bstr path = aFilePath;
     if (aFilePath && *aFilePath)
@@ -4347 +4350 @@
  *                      image-less object.
  *  @param aRegistered  Whether to mark this disk as registered or not
- *                      (ignored when @a aFilePath is @c NULL, assuming @c FALSE)
+ *                      (ignored when @a aLocation is @c NULL, assuming @c FALSE)
  */
 HRESULT HCustomHardDisk::init (VirtualBox *aVirtualBox, HardDisk *aParent,
@@ -4507 +4510 @@
 }
 
-// IVirtualDiskImage properties
+// ICustomHardDisk properties
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -4687 +4690 @@
     }
 
-    aAccessError = Utf8StrFmt ("Hard disk location '%ls' is not yet created",
+    aAccessError = Utf8StrFmt ("Hard disk '%ls' is not yet created",
                                mLocation.raw());
     return S_OK;
@@ -4949 +4952 @@
             else if (VBOX_FAILURE (vrc))
                 *aAccessError = Utf8StrFmt (
-                    tr ("Could not access hard disk image '%ls' (%Vrc)"),
+                    tr ("Could not access hard disk '%ls' (%Vrc)"),
                         mLocation.raw(), vrc);
         }

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

@@ -4930 +4930 @@
     <const name="CustomHardDisk" value="3">
       <desc>
-        Disk formats supported through plugins (the access type (
-        wether regular file in the host OS or something else) is up to
-        the plugin, see <link to="ICustomHardDisk"/>)
+        Disk formats supported through plugins (see
+        <link to="ICustomHardDisk"/>)
       </desc>
     </const>
@@ -5600 +5599 @@
         newly created hard disk objects, this value is <tt>null</tt>.
 
-        When assigning a new path, it can be absolute (full path) or
-        relative to the <link to="IVirtualBox::homeFolder"> VirtualBox
-          home directory</link>. If only a file name without any path is
-        given, the <link to="ISystemProperties::defaultVDIFolder">
-          default VDI folder</link> will be used as a path to the image
-        file.
+        When assigning a new path, it can be absolute (full path) or relative
+        to the <link to="IVirtualBox::homeFolder"> VirtualBox home
+        directory</link>. If only a file name without any path is given,
+        the <link to="ISystemProperties::defaultVDIFolder"> default VDI
+        folder</link> will be used as a path to the image file.
 
         When reading this propery, a full path is always returned.
@@ -5611 +5609 @@
         <note>
           This property cannot be changed when <link to="#created"/>
-          returns <tt>true</tt>. In this case, the specified file name can be
-          absolute (full path) or relative to
-          the <link to="IVirtualBox::homeFolder"> VirtualBox home
-          directory</link>.  If only a file name without any path is given,
-          the <link to="ISystemProperties::defaultVDIFolder"> default VDI
-          folder</link> will be used as a path to the image file.
+          returns <tt>true</tt>.
         </note>
 
@@ -5872 +5865 @@
         <note>
           This property cannot be changed when <link to="#created"/>
-          returns <tt>true</tt>. In this case, the specified file name can be
-          absolute (full path) or relative to
-          the <link to="IVirtualBox::homeFolder"> VirtualBox home
-          directory</link>.  If only a file name without any path is given,
-          the <link to="ISystemProperties::defaultVDIFolder"> default VDI
-          folder</link> will be used as a path to the image file.
+          returns <tt>true</tt>.
         </note>
 
@@ -5983 +5971 @@
 
       The ICustomHardDisk interface represents <link to="IHardDisk">virtual hard
-      disks</link> that are supported through third-parite plugins.
-
-      Hard disks using custom images can be opened using
+      disks</link> that are supported through third-party plugins.
+
+      Hard disks using custom hard disk images can be opened using
       <link to="IVirtualBox::openHardDisk()"/>.
 
@@ -6013 +6001 @@
       <desc>
 
-        Full location path of the custom image of this hard disk.
-
-        When assigning a new path, it must be absolute (full path).
-        When reading this propery, a full path is always returned.
+        Location of this custom hard disk. For
+        newly created hard disk objects, this value is <tt>null</tt>.
+
+        The format of the location string is plugin-dependent. In case if the
+        plugin uses a regular file in the local file system to store hard disk
+        data, then the location is a file path and the following rules apply:
+        <ul>
+          <li>
+            when assigning a new path, it must be absolute (full path) or
+            relative to the <link to="IVirtualBox::homeFolder"> VirtualBox
+            home directory</link>.  If only a file name without any path is
+            given, the <link to="ISystemProperties::defaultVDIFolder"> default
+            VDI folder</link> will be used as a path to the image file.
+          </li>
+          <li>
+            When reading this propery, a full path is always returned.
+          </li>
+        </ul>
 
         <note>
           This property cannot be changed when <link to="#created"/>
-          returns <tt>true</tt>. In this case, the specified file name can be
-          absolute (full path) or relative to
-          the <link to="IVirtualBox::homeFolder"> VirtualBox home
-          directory</link>.  If only a file name without any path is given,
-          the <link to="ISystemProperties::defaultVDIFolder"> default VDI
-          folder</link> will be used as a path to the image file.
+          returns <tt>true</tt>.
         </note>