Changeset 16089 in vbox

Timestamp:

Jan 20, 2009 4:19:59 PM (16 years ago)

Author:

vboxsync

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

41799

Message:

Main: Mention in the docs that hard disk format identifiers are case-insensitive strings.

File:

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

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

@@ -6426 +6426 @@
         installation.
 
+        Keep in mind that the hard disk format identifier
+        (<link to="IHardDiskFormat::id"/>) used in other API calls like
+        <link to="IVirtualBox::createHardDisk2()"/> to refer to a particular
+        hard disk format is a case-insensitive string. This means that, for
+        example, all of the following strings:
+        <pre>
+          "VDI"
+          "vdi"
+          "VdI"</pre>
+        refer to the same hard disk format.
+
         Note that the virtual hard disk framework is backend-based, therefore
         the list of supported formats depends on what backends are currently
@@ -8637 +8648 @@
         Identifier of this format.
 
+        The format identifier is a non-null non-empty ASCII string. Note that
+        this string is case-insensitive. This means that, for example, all of
+        the following strings:
+        <pre>
+          "VDI"
+          "vdi"
+          "VdI"</pre>
+        refer to the same hard disk format.
+
         This string is used in methods of other interfaces where it is necessary
         to specify a hard disk format, such as