Changeset 29336 in vbox

Timestamp:

May 11, 2010 10:38:03 AM (14 years ago)

Author:

vboxsync

Message:

Main: document fFailIfInaccessible

File:

• trunk/src/VBox/Main/MediumImpl.cpp (modified) (1 diff)

trunk/src/VBox/Main/MediumImpl.cpp

@@ -3111 +3111 @@
  * @note Locks the medium tree for reading.
  *
- * @param fFailIfInaccessible Whether to refuse inaccessible media.
+ * @param fFailIfInaccessible If true, this fails with an error if a medium is inaccessible. If false,
+ *          inaccessible media are silently skipped and not locked (i.e. their state remains "Inaccessible");
+ *          this is necessary for a VM's removable images on VM startup for which we do not want to fail.
  * @param fMediumLockWrite  Whether to associate a write lock with this medium.
  * @param pToBeParent       Medium which will become the parent of this medium.