Changeset 3318 in vbox for trunk/include/VBox/com/ErrorInfo.h

Timestamp:

Jun 27, 2007 2:58:18 PM (18 years ago)

Author:

vboxsync

Message:

Main/Glue: Useful enhancements to com::ErrorInfo[Keeper].

File:

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

trunk/include/VBox/com/ErrorInfo.h

@@ -187 +187 @@
     bool isFullAvailable() const { return mIsFullAvailable; }
 
+    /** 
+     *  Returns @c true if both isBasicAvailable() and isFullAvailable() are
+     *  @c false. 
+     */
+    bool isNull() const { return !mIsBasicAvailable && !mIsFullAvailable; }
+
     /**
      *  Returns the COM result code of the failed operation.
@@ -242 +248 @@
      */
     void print (const char *aPrefix = NULL);
+
+    /**
+     *  Resets all collected error information. #isNull() will
+     *  return @c true after this method is called.
+     */
+    void setNull()
+    {
+        mIsBasicAvailable = false;
+        mIsFullAvailable = false;
+
+        mResultCode = S_OK;
+        mInterfaceID.clear();
+        mComponent.setNull();
+        mText.setNull();
+        mNext.reset();
+        mInterfaceName.setNull();
+        mCalleeIID.clear();
+        mCalleeName.setNull();
+        mErrorInfo.setNull();
+    }
 
 protected:
@@ -327 +353 @@
 public:
 
-    /** Constructs a new instance that will fetch the current error info. */
-    ErrorInfoKeeper() : ErrorInfo (false), mForgot (false)
-        { init (true /* aKeepObj */); }
+    /**
+     *  Constructs a new instance that will fetch the current error info if
+     *  @a aIsNull is @c false (by default) or remain uninitialized (null)
+     *  otherwise.
+     *
+     *  @param aIsNull  @true to prevent fetching error info and leave
+     *                  the instance uninitialized.
+     */
+    ErrorInfoKeeper (bool aIsNull = false)
+        : ErrorInfo (false), mForgot (false)
+    {
+        if (!aIsNull)
+            init (true /* aKeepObj */);
+    }
 
     /**
@@ -337 +374 @@
     ~ErrorInfoKeeper() { if (!mForgot) restore(); }
 
+    /** 
+     *  Tries to (re-)fetch error info set on the current thread.  On success,
+     *  the previous error information, if any, will be overwritten with the
+     *  new error information. On failure, or if there is no error information
+     *  available, this instance will be reset to null.
+     */
+    void fetch()
+    {
+        setNull();
+        init (true /* aKeepObj */);
+    }
+
     /**
      *  Restores error info fetched by the constructor and forgets it
@@ -349 +398 @@
      *  being restored by #restore() or by the destructor.
      */
-    void forget() { mForgot = 0; }
+    void forget() { mForgot = true; }
 
     /**
@@ -356 +405 @@
      *  stored error info object to the caller.
      */
-    ComPtr <IUnknown> takeError() { mForgot = 0; return mErrorInfo; }
+    ComPtr <IUnknown> takeError() { mForgot = true; return mErrorInfo; }
 
 private: