Changeset 14849 in vbox for trunk/src

Timestamp:

Dec 1, 2008 11:09:19 AM (16 years ago)

Author:

vboxsync

Message:

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

• IConsole::takeSnapshot
• IConsole::discardSnapshot
• IConsole::discardCurrentState
• IConsole::discardCurrentSnapshotAndState
• IConsole::registerCallback
• IConsole::unregisterCallback

Location:

trunk/src/VBox/Main

Files:

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

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -2264 +2264 @@
     if (mMachineState > MachineState_Paused)
     {
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot take a snapshot of the machine "
                 "while it is changing the state (machine state: %d)"),
@@ -2434 +2434 @@
 
     if (mMachineState >= MachineState_Running)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot discard a snapshot of the running machine "
                 "(machine state: %d)"),
@@ -2455 +2455 @@
 
     if (mMachineState >= MachineState_Running)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot discard the current state of the running machine "
                 "(nachine state: %d)"),
@@ -2476 +2476 @@
 
     if (mMachineState >= MachineState_Running)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Cannot discard the current snapshot and state of the "
                 "running machine (machine state: %d)"),

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

@@ -4955 +4955 @@
 
         <see>ISnapshot, <link to="#saveState"/></see>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine currently changing state.
+        </result>
       </desc>
       <param name="name" type="wstring" dir="in">
@@ -5049 +5052 @@
           make all current machine settings permanent.
         </note>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine is running.
+        </result>
       </desc>
       <param name="id" type="uuid" dir="in">
@@ -5085 +5091 @@
         </note>
 
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine is running.
+        </result>
       </desc>
       <param name="progress" type="IProgress" dir="return">
@@ -5129 +5138 @@
 
         <note>
-          This method is more efficient than calling two above
+          This method is more efficient than calling both of the above
           methods separately: it requires less IPC calls and provides
           a single progress object.
         </note>
 
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Virtual machine is running.
+        </result>
       </desc>
       <param name="progress" type="IProgress" dir="return">
@@ -5153 +5165 @@
         Unregisters the console callback previously registered using
         <link to="#registerCallback"/>.
+        <result name="E_INVALIDARG">
+          Given @a callback handler is not registered.
+        </result>
       </desc>
       <param name="callback" type="IConsoleCallback" dir="in"/>