Changeset 14846 in vbox for trunk/src/VBox

Timestamp:

Dec 1, 2008 10:26:21 AM (16 years ago)

Author:

vboxsync

Message:

#3285: Improve error handling API to include unique error numbers
Document

• IConsole::createSharedFolder
• IConsole::removeSharedFolder

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (5 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -2127 +2127 @@
     /// @todo see @todo in AttachUSBDevice() about the Paused state
     if (mMachineState == MachineState_Saved)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot create a transient shared folder on the "
                 "machine in the saved state"));
     if (mMachineState > MachineState_Paused)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot create a transient shared folder on the "
                 "machine while it is changing the state (machine state: %d)"),
@@ -2139 +2139 @@
     HRESULT rc = findSharedFolder (aName, sharedFolder, false /* aSetError */);
     if (SUCCEEDED (rc))
-        return setError (E_FAIL,
+        return setError (VBOX_E_FILE_ERROR,
             tr ("Shared folder named '%ls' already exists"), aName);
 
@@ -2151 +2151 @@
 
     if (!accessible)
-        return setError (E_FAIL,
+        return setError (VBOX_E_FILE_ERROR,
             tr ("Shared folder host path '%ls' is not accessible"), aHostPath);
 
@@ -2199 +2199 @@
     /// @todo see @todo in AttachUSBDevice() about the Paused state
     if (mMachineState == MachineState_Saved)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot remove a transient shared folder from the "
                 "machine in the saved state"));
     if (mMachineState > MachineState_Paused)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot remove a transient shared folder from the "
                 "machine while it is changing the state (machine state: %d)"),
@@ -4974 +4974 @@
 
     if (aSetError)
-        setError (E_INVALIDARG,
+        setError (VBOX_E_FILE_ERROR,
                   tr ("Could not find a shared folder named '%ls'."), aName);
 
-    return E_INVALIDARG;
+    return VBOX_E_FILE_ERROR;
 }
 

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

@@ -4897 +4897 @@
         folders and starts sharing it. Refer to the description of
         <link to="ISharedFolder"/> to read more about logical names.
+
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine in Saved state or currently changing state.
+        </result>
+        <result name="VBOX_E_FILE_ERROR">
+          Shared folder already exists or not accessible.
+        </result>
       </desc>
       <param name="name" type="wstring" dir="in">
@@ -4914 +4921 @@
         created by <link to="#createSharedFolder"/> from the collection of
         shared folders and stops sharing it.
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine in Saved state or currently changing state.
+        </result>
+        <result name="VBOX_E_FILE_ERROR">
+          Shared folder does not exists.
+        </result>
       </desc>
       <param name="name" type="wstring" dir="in">