Changeset 3044

Timestamp:

06/05/07 12:37:38 (2 years ago)

Author:

vboxsync

Message:

Main: Added ErrorInfoKeeper::takeError().

Files:

• trunk/include/VBox/com/ErrorInfo.h (modified) (4 diffs)

trunk/include/VBox/com/ErrorInfo.h

@@ -303 +303 @@
- *  error information while it still needs to make another call before return.
- *
+ *  Instead of calling #restore() explicitly you may let the object destructor
+ *  do it for you, if you correctly limit the object's lifeime.
+ *
- *  The usage pattern is:
- *  <code>
@@ -313 +316 @@
- *           bar->method();
- *           ...
-
-
+
+
+
- *           return rc;
- *      }
@@ -329 +333 @@
-    /**
-     *  Destroys this instance and automatically calls #restore() which will
-r
+e
-     *  if #forget() was called before destruction. */
-    ~ErrorInfoKeeper() { if (!mForgot) restore(); }
@@ -342 +346 @@
-
-    /**
-which prevents
+to prevent
-     *  being restored by #restore() or by the destructor.
-     */
-    void forget() { mForgot = 0; }
+
+    /**
+     *  Forgets error info fetched by the constructor to prevent it from
+     *  being restored by #restore() or by the destructor, and returns the
+     *  stored error info object to the caller.
+     */
+    ComPtr <IUnknown> takeError() { mForgot = 0; return mErrorInfo; }
-
-private: