儲存庫 vbox 的更動 15039

時間撮記:

2008-12-5 下午01:07:27 (16 年 以前)

作者:

vboxsync

訊息:

#3285: Improve error handling API to include unique error numbers
Document/improve IInternalMachineControl results.

位置:

trunk/src/VBox/Main

檔案:

• MachineImpl.cpp (修改) (11 筆差異)
• idl/VirtualBox.xidl (修改) (7 筆差異)

trunk/src/VBox/Main/MachineImpl.cpp

@@ -8043 +8043 @@
  *  @note Locks the same as #setMachineState() does.
  */
-STDMETHODIMP SessionMachine::UpdateState (MachineState_T machineState)
-{
-    return setMachineState (machineState);
+STDMETHODIMP SessionMachine::UpdateState (MachineState_T aMachineState)
+{
+    return setMachineState (aMachineState);
 }
 
@@ -8051 +8051 @@
  *  @note Locks this object for reading.
  */
-STDMETHODIMP SessionMachine::GetIPCId (BSTR *id)
+STDMETHODIMP SessionMachine::GetIPCId (BSTR *aId)
 {
     AutoCaller autoCaller (this);
@@ -8059 +8059 @@
 
 #if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
-    mIPCSemName.cloneTo (id);
+    mIPCSemName.cloneTo (aId);
     return S_OK;
 #elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
-    mData->mConfigFileFull.cloneTo (id);
+    mData->mConfigFileFull.cloneTo (aId);
     return S_OK;
 #else
@@ -8115 +8115 @@
     return service->captureDeviceForVM (this, aId);
 #else
-    return E_FAIL;
+    return E_NOTIMPL;
 #endif
 }
@@ -8134 +8134 @@
     return service->detachDeviceFromVM (this, aId, !!aDone);
 #else
-    return E_FAIL;
+    return E_NOTIMPL;
 #endif
 }
@@ -8374 +8374 @@
     int vrc = calculateFullPath (stateFilePathFull, stateFilePathFull);
     if (RT_FAILURE (vrc))
-        return setError (E_FAIL,
+        return setError (VBOX_E_FILE_ERROR,
             tr ("Invalid saved state file path '%ls' (%Rrc)"),
                 aSavedStateFile, vrc);
@@ -8605 +8605 @@
         size_t childrenCount = snapshot->children().size();
         if (childrenCount > 1)
-            return setError (E_FAIL,
+            return setError (VBOX_E_INVALID_OBJECT_STATE,
                 tr ("Snapshot '%ls' of the machine '%ls' has more than one "
                     "child snapshot (%d)"),
@@ -8678 +8678 @@
 
     if (mData->mCurrentSnapshot.isNull())
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_OBJECT_STATE,
             tr ("Could not discard the current state of the machine '%ls' "
                 "because it doesn't have any snapshots"),
@@ -8742 +8742 @@
 
     if (mData->mCurrentSnapshot.isNull())
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_OBJECT_STATE,
             tr ("Could not discard the current state of the machine '%ls' "
                 "because it doesn't have any snapshots"),
@@ -8922 +8922 @@
     using namespace guestProp;
 
-    if (!VALID_PTR(aName))
-        return E_POINTER;
+    CheckComArgNotNull(aName);
     if ((aValue != NULL) && (!VALID_PTR(aValue) || !VALID_PTR(aFlags)))
         return E_POINTER;  /* aValue can be NULL to indicate deletion */
@@ -8941 +8940 @@
 
     bool matchAll = false;
-    if (0 == utf8Patterns.length())
+    if (utf8Patterns.length() == 0)
         matchAll = true;
 

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

@@ -2726 +2726 @@
         the state previously requested by #beginSavingState is either
         successfully finished or there was a failure.
+
+        <result name="VBOX_E_FILE_ERROR">
+          Settings file not accessible.
+        </result>
+        <result name="VBOX_E_XML_ERROR">
+          Could not parse the settings file.
+        </result>
+
       </desc>
 
       <param name="success" type="boolean" dir="in">
-        <desc><tt>true</tt> to indicate success and <tt>false</tt> otherwise</desc>
+        <desc><tt>true</tt> to indicate success and <tt>false</tt>
+          otherwise.
+        </desc>
       </param>
     </method>
@@ -2736 +2746 @@
       <desc>
         Gets called by IConsole::adoptSavedState.
+        <result name="VBOX_E_FILE_ERROR">
+          Invalid saved state file path.
+        </result>
       </desc>
       <param name="savedStateFile" type="wstring" dir="in">
@@ -2746 +2759 @@
         Called by the VM process to inform the server it wants to
         take a snapshot.
+
+        <result name="VBOX_E_FILE_ERROR">
+          Settings file not accessible.
+        </result>
+        <result name="VBOX_E_XML_ERROR">
+          Could not parse the settings file.
+        </result>
       </desc>
       <param name="initiator" type="IConsole" dir="in">
@@ -2751 +2771 @@
       </param>
       <param name="name" type="wstring" dir="in">
-        <desc>Snapshot name</desc>
+        <desc>Snapshot name.</desc>
       </param>
       <param name="description" type="wstring" dir="in">
-        <desc>Snapshot description</desc>
+        <desc>Snapshot description.</desc>
       </param>
       <param name="progress" type="IProgress" dir="in">
@@ -2790 +2810 @@
       <desc>
         Gets called by IConsole::discardSnapshot.
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Snapshot has more than one child snapshot.
+        </result>
       </desc>
       <param name="initiator" type="IConsole" dir="in">
@@ -2808 +2831 @@
       <desc>
         Gets called by IConsole::discardCurrentState.
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Virtual machine does not have any snapshot.
+        </result>
       </desc>
       <param name="initiator" type="IConsole" dir="in">
@@ -2823 +2849 @@
       <desc>
         Gets called by IConsole::discardCurrentSnapshotAndState.
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Virtual machine does not have any snapshot.
+        </result>
       </desc>
       <param name="initiator" type="IConsole" dir="in">