Changeset 98263 in vbox for trunk/src/VBox/Main/include/AutoCaller.h

Timestamp:

Jan 24, 2023 1:52:49 AM (23 months ago)

Author:

vboxsync

Message:

Main: rc() -> hrc()/vrc().

File:

• trunk/src/VBox/Main/include/AutoCaller.h (modified) (6 diffs)

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

@@ -54 +54 @@
  * destroyed).
  *
- * If #rc() returns a failure after the instance creation, it means that
+ * If #hrc() returns a failure after the instance creation, it means that
  * the managed VirtualBoxBase object is not Ready, or in any other invalid
  * state, so that the caller must not use the object and can return this
@@ -97 +97 @@
      * @param aObj      Object to add a normal caller to. If NULL, this
      *                  instance is effectively turned to no-op (where
-     *                  rc() will return S_OK).
+     *                  hrc() will return S_OK).
      */
     AutoCaller(VirtualBoxBase *aObj)
@@ -124 +124 @@
 
     /**
-     * Returns the stored result code returned by ObjectState::addCaller()
-     * after instance creation or after the last #add() call. A successful
-     * result code means the number of callers was successfully increased.
-     * @deprecated use hrc()
-     */
-    HRESULT rc() const { return mRC; }
-
-    /**
-     * Returns |true| if |SUCCEEDED(rc())| is |true|, for convenience.
-     * |true| means the number of callers was successfully increased.
+     * Returns |true| if |SUCCEEDED(hrc())| is |true|, for convenience. |true| means
+     * the number of callers was successfully increased.
      */
     bool isOk() const { return SUCCEEDED(mRC); }
 
     /**
-     * Returns |true| if |FAILED(rc())| is |true|, for convenience.
-     * |true| means the number of callers was _not_ successfully increased.
+     * Returns |true| if |FAILED(hrc())| is |true|, for convenience. |true| means
+     * the number of callers was _not_ successfully increased.
      */
     bool isNotOk() const { return FAILED(mRC); }
@@ -145 +137 @@
     /**
      * Temporarily decreases the number of callers of the managed object.
-     * May only be called if #isOk() returns |true|. Note that #rc() will
-     * return E_FAIL after this method succeeds.
+     * May only be called if #isOk() returns |true|. Note that #hrc() will return
+     * E_FAIL after this method succeeds.
      */
     void release()
@@ -204 +196 @@
      *
      * @param aObj      Object to add a caller to. If NULL, this
-     *                  instance is effectively turned to no-op (where
-     *                  rc() will return S_OK).
+     *                  instance is effectively turned to no-op (where hrc() will
+     *                  return S_OK).
      * @param aLimited  If |false|, then it's a regular caller, otherwise a
      *                  limited caller.
@@ -268 +260 @@
      *
      * @param aObj      Object to add a limited caller to. If NULL, this
-     *                  instance is effectively turned to no-op (where
-     *                  rc() will return S_OK).
+     *                  instance is effectively turned to no-op (where hrc() will
+     *                  return S_OK).
      */
     AutoLimitedCaller(VirtualBoxBase *aObj)