Changeset 357 in vbox for trunk

Timestamp:

Jan 26, 2007 2:46:16 PM (18 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

17921

Message:

Main: Added VirtualBoxSupportErrorInfoImpl::setErrorBstr() and Progress::notifyCompleteBstr() to avoid an extra Utf8Str -> Bstr conversion.

Location:

trunk/src/VBox/Main

Files:

• ProgressImpl.cpp (modified) (2 diffs)
• include/ProgressImpl.h (modified) (1 diff)
• include/VirtualBoxBase.h (modified) (2 diffs)

trunk/src/VBox/Main/ProgressImpl.cpp

@@ -839 +839 @@
                                   const char *aText, ...)
 {
+    va_list args;
+    va_start (args, aText);
+    Bstr text = Utf8StrFmt (aText, args);
+    va_end (args);
+    
+    return notifyCompleteBstr (aResultCode, aIID, aComponent, text);
+}
+
+/**
+ *  Marks the operation as complete and attaches full error info.
+ *  See VirtualBoxSupportErrorInfoImpl::setError(HRESULT, const GUID &, const wchar_t *, const char *, ...)
+ *  for more info.
+ *
+ *  This method is preferred iy you have a ready (translated and formatted)
+ *  Bstr string, because it omits an extra conversion Utf8Str -> Bstr.
+ * 
+ *  @param  aResultCode operation result (error) code, must not be S_OK
+ *  @param  aIID        IID of the intrface that defines the error
+ *  @param  aComponent  name of the component that generates the error
+ *  @param  aText       error message (must not be null)
+ */
+HRESULT Progress::notifyCompleteBstr (HRESULT aResultCode, const GUID &aIID,
+                                      const Bstr &aComponent, const Bstr &aText)
+{
     AutoLock lock (this);
     AssertReturn (isReady(), E_UNEXPECTED);
@@ -852 +876 @@
     if (SUCCEEDED (rc))
     {
-        va_list args;
-        va_start (args, aText);
-        Bstr bstrText = Utf8StrFmt (aText, args);
-        va_end (args);
-        errorInfo->init (aResultCode, aIID, aComponent, bstrText);
+        errorInfo->init (aResultCode, aIID, aComponent, aText);
         errorInfo.queryInterfaceTo (mErrorInfo.asOutParam());
     }

trunk/src/VBox/Main/include/ProgressImpl.h

@@ -182 +182 @@
                             const Bstr &aComponent,
                             const char *aText, ...);
+    HRESULT notifyCompleteBstr (HRESULT aResultCode, const GUID &aIID,
+                                const Bstr &aComponent, const Bstr &aText);
 
 private:

trunk/src/VBox/Main/include/VirtualBoxBase.h

@@ -1214 +1214 @@
      *
      *  See #setError (HRESULT, const GUID &, const wchar_t *, const char *text, ...)
-     *  for details.
-     *
-     *  This method is the most common (and convenient) way  to set error
-     *  information from within interface methods. A typical pattern of usage
-     *  is looks like this:
-     *
-     *  <code>
-     *      return setErrorV (E_FAIL, pszFormat, args);
-     *  </code>
-     *  or
-     *  <code>
-     *      HRESULT rc = setErrorV (E_FAIL, pszFormat, args);
-     *      ...
-     *      return rc;
-     *  </code>
+     *  and #setError (HRESULT, const char *, ...)  for details.
      */
     inline static HRESULT setErrorV (HRESULT resultCode, const char *text, va_list args)
@@ -1234 +1220 @@
         HRESULT rc = VirtualBoxSupportErrorInfoImplBase::setError (
             resultCode, COM_IIDOF(I), C::getComponentName(), text, args);
+        return rc;
+    }
+
+    /**
+     *  Sets the error information for the current thread, BStr variant.
+     *  A convenience method that automatically sets the default interface
+     *  ID (taken from the I template argument) and the component name
+     *  (a value of C::getComponentName()).
+     *
+     *  This method is preferred iy you have a ready (translated and formatted)
+     *  Bstr string, because it omits an extra conversion Utf8Str -> Bstr. 
+     *
+     *  See #setError (HRESULT, const GUID &, const wchar_t *, const char *text, ...)
+     *  and #setError (HRESULT, const char *, ...)  for details.
+     */
+    inline static HRESULT setErrorBstr (HRESULT resultCode, const Bstr &text)
+    {
+        HRESULT rc = VirtualBoxSupportErrorInfoImplBase::setError (
+            resultCode, COM_IIDOF(I), C::getComponentName(), text);
         return rc;
     }