Changeset 15140 in vbox for trunk/src/VBox/Main/MachineImpl.cpp

Timestamp:

Dec 9, 2008 8:41:26 AM (16 years ago)

Author:

vboxsync

Message:

#3285: Improve error handling API to include unique error numbers
Document IMachine interface, part II.

File:

• trunk/src/VBox/Main/MachineImpl.cpp (modified) (21 diffs)

trunk/src/VBox/Main/MachineImpl.cpp

@@ -2284 +2284 @@
 STDMETHODIMP Machine::GetSerialPort (ULONG slot, ISerialPort **port)
 {
-    if (!port)
-        return E_POINTER;
-    if (slot >= RT_ELEMENTS (mSerialPorts))
-        return setError (E_INVALIDARG, tr ("Invalid slot number: %d"), slot);
+    CheckComArgOutPointerValid(port);
+    CheckComArgExpr(slot, slot < RT_ELEMENTS (mSerialPorts));
 
     AutoCaller autoCaller (this);
@@ -2301 +2299 @@
 STDMETHODIMP Machine::GetParallelPort (ULONG slot, IParallelPort **port)
 {
-    if (!port)
-        return E_POINTER;
-    if (slot >= RT_ELEMENTS (mParallelPorts))
-        return setError (E_INVALIDARG, tr ("Invalid slot number: %d"), slot);
+    CheckComArgOutPointerValid(port);
+    CheckComArgExpr(slot, slot < RT_ELEMENTS (mParallelPorts));
 
     AutoCaller autoCaller (this);
@@ -2318 +2314 @@
 STDMETHODIMP Machine::GetNetworkAdapter (ULONG slot, INetworkAdapter **adapter)
 {
-    if (!adapter)
-        return E_POINTER;
-    if (slot >= RT_ELEMENTS (mNetworkAdapters))
-        return setError (E_INVALIDARG, tr ("Invalid slot number: %d"), slot);
+    CheckComArgOutPointerValid(adapter);
+    CheckComArgExpr(slot, slot < RT_ELEMENTS (mNetworkAdapters));
 
     AutoCaller autoCaller (this);
@@ -2419 +2413 @@
 
         /* Here we are when a) there are no items at all or b) there are items
-         * but none of them equals to the requested non-NULL key. b) is an
+         * but none of them equals the requested non-NULL key. b) is an
          * error as well as a) if the key is non-NULL. When the key is NULL
          * (which is the case only when there are no items), we just fall
@@ -2425 +2419 @@
 
         if (aKey != NULL)
-            return setError (E_FAIL,
+            return setError (VBOX_E_OBJECT_NOT_FOUND,
                 tr ("Could not find the extra data key '%ls'"), aKey);
     }
@@ -2712 +2706 @@
 
     if (mData->mRegistered)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot delete settings of a registered machine"));
 
@@ -2721 +2715 @@
         int vrc = RTFileDelete (Utf8Str (mData->mConfigFileFull));
         if (RT_FAILURE (vrc))
-            return setError (E_FAIL,
+            return setError (VBOX_E_IPRT_ERROR,
                 tr ("Could not delete the settings file '%ls' (%Rrc)"),
                 mData->mConfigFileFull.raw(), vrc);
@@ -2834 +2828 @@
     rc = findSharedFolder (aName, sharedFolder, false /* aSetError */);
     if (SUCCEEDED (rc))
-        return setError (E_FAIL,
+        return setError (VBOX_E_OBJECT_IN_USE,
             tr ("Shared folder named '%ls' already exists"), aName);
 
@@ -2846 +2840 @@
 
     if (!accessible)
-        return setWarning (E_FAIL,
+        return setWarning (VBOX_E_FILE_ERROR,
             tr ("Shared folder host path '%ls' is not accessible"), aHostPath);
 
@@ -2894 +2888 @@
     AutoCaller autoCaller (this);
     AssertComRCReturnRC (autoCaller.rc());
+
+    ComPtr <IInternalSessionControl> directControl;
+    {
+        AutoReadLock alock (this);
+
+        if (mData->mSession.mState != SessionState_Open)
+            return setError (VBOX_E_INVALID_VM_STATE,
+                tr ("Machine session is not open (session state: %d)"),
+                mData->mSession.mState);
+
+        directControl = mData->mSession.mDirectControl;
+    }
+
+    /* ignore calls made after #OnSessionEnd() is called */
+    if (!directControl)
+        return S_OK;
+
+    ULONG64 dummy;
+    return directControl->OnShowWindow (TRUE /* aCheck */, aCanShow, &dummy);
+}
+
+STDMETHODIMP Machine::ShowConsoleWindow (ULONG64 *aWinId)
+{
+    CheckComArgOutPointerValid(aWinId);
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
 
     ComPtr <IInternalSessionControl> directControl;
@@ -2911 +2932 @@
         return S_OK;
 
-    ULONG64 dummy;
-    return directControl->OnShowWindow (TRUE /* aCheck */, aCanShow, &dummy);
-}
-
-STDMETHODIMP Machine::ShowConsoleWindow (ULONG64 *aWinId)
-{
-    CheckComArgOutPointerValid(aWinId);
-
-    AutoCaller autoCaller (this);
-    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
-
-    ComPtr <IInternalSessionControl> directControl;
-    {
-        AutoReadLock alock (this);
-
-        if (mData->mSession.mState != SessionState_Open)
-            return setError (E_FAIL,
-                tr ("Machine session is not open (session state: %d)"),
-                mData->mSession.mState);
-
-        directControl = mData->mSession.mDirectControl;
-    }
-
-    /* ignore calls made after #OnSessionEnd() is called */
-    if (!directControl)
-        return S_OK;
-
     BOOL dummy;
     return directControl->OnShowWindow (FALSE /* aCheck */, &dummy, aWinId);
@@ -2947 +2941 @@
     ReturnComNotImplemented();
 #else
-    if (!VALID_PTR (aName))
-        return E_INVALIDARG;
-    if (!VALID_PTR (aValue))
-        return E_POINTER;
-    if (!VALID_PTR (aTimestamp))
-        return E_POINTER;
-    if (!VALID_PTR (aFlags))
-        return E_POINTER;
+    CheckComArgNotNull(aName);
+    CheckComArgOutPointerValid(aValue);
+    CheckComArgOutPointerValid(aTimestamp);
+    CheckComArgOutPointerValid(aFlags);
 
     AutoCaller autoCaller (this);
@@ -3019 +3009 @@
     using namespace guestProp;
 
-    if (!VALID_PTR (aName))
-        return E_INVALIDARG;
+    CheckComArgNotNull(aName);
     if ((aValue != NULL) && !VALID_PTR (aValue))
         return E_INVALIDARG;
@@ -3060 +3049 @@
         property.mFlags = NILFLAG;
         if (fFlags & TRANSIENT)
-            rc = setError (E_INVALIDARG, tr ("Cannot set a transient property when the machine is not running"));
+            rc = setError (VBOX_E_INVALID_OBJECT_STATE, tr ("Cannot set a transient property when the machine is not running"));
         if (SUCCEEDED (rc))
         {
@@ -3143 +3132 @@
     if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
         return E_POINTER;
-    if (ComSafeArrayOutIsNull (aNames))
-        return E_POINTER;
-    if (ComSafeArrayOutIsNull (aValues))
-        return E_POINTER;
-    if (ComSafeArrayOutIsNull (aTimestamps))
-        return E_POINTER;
-    if (ComSafeArrayOutIsNull (aFlags))
-        return E_POINTER;
+    CheckComArgSafeArrayNotNull(aNames);
+    CheckComArgSafeArrayNotNull(aValues);
+    CheckComArgSafeArrayNotNull(aTimestamps);
+    CheckComArgSafeArrayNotNull(aFlags);
 
     AutoCaller autoCaller (this);
@@ -4303 +4288 @@
                  mData->mMachineState > MachineState_Paused ||
                  mData->mMachineState == MachineState_Saved))
-                return setError (E_ACCESSDENIED,
+                return setError (VBOX_E_INVALID_VM_STATE,
                     tr ("The machine is not mutable (state is %d)"),
                     mData->mMachineState);
@@ -4313 +4298 @@
                 (mType != IsSessionMachine ||
                  mData->mMachineState > MachineState_Paused))
-                return setError (E_ACCESSDENIED,
+                return setError (VBOX_E_INVALID_VM_STATE,
                     tr ("The machine is not mutable (state is %d)"),
                     mData->mMachineState);
@@ -4621 +4606 @@
  *                          not found
  *  @return
- *      S_OK when found or E_INVALIDARG when not found
+ *      S_OK when found or VBOX_E_OBJECT_NOT_FOUND when not found
  *
  *  @note
@@ -4641 +4626 @@
     }
 
-    HRESULT rc = found ? S_OK : E_INVALIDARG;
+    HRESULT rc = found ? S_OK : VBOX_E_OBJECT_NOT_FOUND;
 
     if (aSetError && !found)
@@ -5518 +5503 @@
     {
         if (aSetError)
-            return setError (E_FAIL,
+            return setError (VBOX_E_OBJECT_NOT_FOUND,
                 tr ("This machine does not have any snapshots"));
-        return E_FAIL;
+        return VBOX_E_OBJECT_NOT_FOUND;
     }
 
@@ -5528 +5513 @@
     {
         if (aSetError)
-            return setError (E_FAIL,
+            return setError (VBOX_E_OBJECT_NOT_FOUND,
                 tr ("Could not find a snapshot named '%ls'"), aName);
-        return E_FAIL;
+        return VBOX_E_OBJECT_NOT_FOUND;
     }