Changeset 35602 in vbox for trunk/src/VBox/Main/src-server/SnapshotImpl.cpp

Timestamp:

Jan 18, 2011 11:27:20 AM (14 years ago)

Author:

vboxsync

Message:

Main: fix and clarify that ISnapshot::SetName and SetDescription automatically save the machine settings; API docs

File:

• trunk/src/VBox/Main/src-server/SnapshotImpl.cpp (modified) (5 diffs)

trunk/src/VBox/Main/src-server/SnapshotImpl.cpp

@@ -346 +346 @@
 STDMETHODIMP Snapshot::COMSETTER(Name)(IN_BSTR aName)
 {
+    HRESULT rc = S_OK;
     CheckComArgStrNotEmptyOrNull(aName);
 
@@ -358 +359 @@
     {
         m->strName = strName;
-
         alock.leave(); /* Important! (child->parent locks are forbidden) */
-
-        // flag the machine as dirty or change won't get saved
-        AutoWriteLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
-        m->pMachine->setModified(Machine::IsModified_Snapshots);
-        mlock.leave();
-
-        return m->pMachine->onSnapshotChange(this);
-    }
-
-    return S_OK;
+        rc = m->pMachine->onSnapshotChange(this);
+    }
+
+    return rc;
 }
 
@@ -387 +381 @@
 STDMETHODIMP Snapshot::COMSETTER(Description)(IN_BSTR aDescription)
 {
+    HRESULT rc = S_OK;
     AutoCaller autoCaller(this);
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
@@ -397 +392 @@
     {
         m->strDescription = strDescription;
-
         alock.leave(); /* Important! (child->parent locks are forbidden) */
-
-        // flag the machine as dirty or change won't get saved
-        AutoWriteLock mlock(m->pMachine COMMA_LOCKVAL_SRC_POS);
-        m->pMachine->setModified(Machine::IsModified_Snapshots);
-        mlock.leave();
-
-        return m->pMachine->onSnapshotChange(this);
-    }
-
-    return S_OK;
+        rc = m->pMachine->onSnapshotChange(this);
+    }
+
+    return rc;
 }
 
@@ -1193 +1181 @@
  *  snapshot data such as name or description is changed.
  *
- *  @note Locks this object for writing.
+ *  @warning Caller must hold no locks when calling this.
  */
 HRESULT SnapshotMachine::onSnapshotChange(Snapshot *aSnapshot)
 {
-    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    //     mPeer->saveAllSnapshots();  @todo
+    AutoMultiWriteLock2 mlock(this, aSnapshot COMMA_LOCKVAL_SRC_POS);
+    Guid uuidMachine(mData->mUuid),
+         uuidSnapshot(aSnapshot->getId());
+    bool fNeedsGlobalSaveSettings = false;
+
+    // flag the machine as dirty or change won't get saved
+    mPeer->setModified(Machine::IsModified_Snapshots);
+    HRESULT rc = mPeer->saveSettings(&fNeedsGlobalSaveSettings,
+                                     SaveS_Force);        // we know we need saving, no need to check
+    mlock.leave();
+
+    if (SUCCEEDED(rc) && fNeedsGlobalSaveSettings)
+    {
+        // save the global settings
+        AutoWriteLock vboxlock(mParent COMMA_LOCKVAL_SRC_POS);
+        rc = mParent->saveSettings();
+    }
 
     /* inform callbacks */
-    mParent->onSnapshotChange(mData->mUuid, aSnapshot->getId());
-
-    return S_OK;
+    mParent->onSnapshotChange(uuidMachine, uuidSnapshot);
+
+    return rc;
 }