Changeset 33334 in vbox for trunk/src/VBox/Main

Timestamp:

Oct 22, 2010 9:44:03 AM (14 years ago)

Author:

vboxsync

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

66915

Message:

Main/MediumImpl: clarify what medium format is used for src/dst for exportFile/importFile.

File:

• trunk/src/VBox/Main/include/MediumImpl.h (modified) (4 diffs)

trunk/src/VBox/Main/include/MediumImpl.h

@@ -246 +246 @@
      *
      * @param aFilename             Filename to create (UTF8).
-     * @param aFormat               Which medium format to use for export.
+     * @param aFormat               Medium format for creating @a aFilename.
      * @param aVariant              Which exact image format variant to use.
      * @param aVDImageIOCallbacks   Pointer to the callback table for a
@@ -253 +253 @@
      * @param aProgress             Progress object to use.
      * @return
+     * @note The source format is defined by the Medium instance.
      */
     HRESULT exportFile(const char *aFilename,
@@ -263 +264 @@
      *
      * @param aFilename             Filename to read (UTF8).
-     * @param aFormat               Which medium format to use for import.
+     * @param aFormat               Medium format for reading @a aFilename.
      * @param aVariant              Which exact image format variant to use.
      * @param aVDImageIOCallbacks   Pointer to the callback table for a
@@ -271 +272 @@
      * @param aProgress             Progress object to use.
      * @return
+     * @note The destination format is defined by the Medium instance.
      */
     HRESULT importFile(const char *aFilename,