Changeset 98262 in vbox for trunk/src/VBox/Main/include

Timestamp:

Jan 24, 2023 1:42:14 AM (2 years ago)

Author:

vboxsync

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

155461

Message:

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

Location:

trunk/src/VBox/Main/include

Files:

• AutoCaller.h (modified) (3 diffs)
• AutoStateDep.h (modified) (7 diffs)
• ConsoleImpl.h (modified) (6 diffs)
• GuestSessionImpl.h (modified) (2 diffs)

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

@@ -69 +69 @@
  * {
  *     AutoCaller autoCaller(this);
- *     HRESULT hrc = autoCaller.rc();
+ *     HRESULT hrc = autoCaller.hrc();
  *     if (SUCCEEDED(hrc))
  *     {
@@ -115 +115 @@
 
     /**
+     * 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.
+     */
+    HRESULT hrc() const { return mRC; }
+
+    /**
      * 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; }
@@ -230 +240 @@
  * {
  *     AutoLimitedCaller autoCaller(this);
- *     HRESULT hrc = autoCaller.rc();
+ *     HRESULT hrc = autoCaller.hrc();
  *     if (SUCCEEDED(hrc))
  *     {

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

@@ -44 +44 @@
      *  @code
      *      AutoCaller autoCaller(this);
-     *      if (FAILED(autoCaller.rc())) return autoCaller.rc();
+     *      if (FAILED(autoCaller.hrc())) return autoCaller.hrc();
      *
      *      Machine::AutoStateDependency<MutableStateDep> adep(mParent);
-     *      if (FAILED(stateDep.rc())) return stateDep.rc();
+     *      if (FAILED(stateDep.hrc())) return stateDep.hrc();
      *      ...
      *      // code that depends on the particular machine state
@@ -103 +103 @@
 
         /** Returns the result of Machine::addStateDependency(). */
+        HRESULT hrc() const { return mRC; }
+        /** Returns the result of Machine::addStateDependency().
+         * @deprecated Use #hrc() instead.  */
         HRESULT rc() const { return mRC; }
 
-        /** Shortcut to SUCCEEDED(rc()). */
+        /** Shortcut to SUCCEEDED(hrc()). */
         bool isOk() const { return SUCCEEDED(mRC); }
 
@@ -136 +139 @@
      *  this object is destroyed. If the machine state cannot be protected (as
      *  a result of the state change currently in progress), this instance's
-     *  #rc() method will indicate a failure, and the caller is not allowed to
+     *  #hrc() method will indicate a failure, and the caller is not allowed to
      *  rely on any particular machine state and should return the failed
      *  result code to the upper level.
@@ -148 +151 @@
      *  Succeeds only if the machine state is in one of the mutable states, and
      *  guarantees the given mutable state won't change before this object is
-     *  destroyed. If the machine is not mutable, this instance's #rc() method
+     *  destroyed. If the machine is not mutable, this instance's #hrc() method
      *  will indicate a failure, and the caller is not allowed to rely on any
      *  particular machine state and should return the failed result code to
@@ -167 +170 @@
      *  if the machine is in the Saved state, and guarantees the given mutable
      *  state won't change before this object is destroyed. If the machine is
-     *  not mutable, this instance's #rc() method will indicate a failure, and
+     *  not mutable, this instance's #hrc() method will indicate a failure, and
      *  the caller is not allowed to rely on any particular machine state and
      *  should return the failed result code to the upper level.
@@ -183 +186 @@
      *  if the machine is in the Running or Paused state, and guarantees the
      *  given mutable state won't change before this object is destroyed. If
-     *  the machine is not mutable, this instance's #rc() method will indicate
+     *  the machine is not mutable, this instance's #hrc() method will indicate
      *  a failure, and the caller is not allowed to rely on any particular
      *  machine state and should return the failed result code to the upper
@@ -200 +203 @@
      *  if the machine is in the Running, Paused or Saved state, and guarantees
      *  the given mutable state won't change before this object is destroyed.
-     *  If the machine is not mutable, this instance's #rc() method will
+     *  If the machine is not mutable, this instance's #hrc() method will
      *  indicate a failure, and the caller is not allowed to rely on any
      *  particular machine state and should return the failed result code to

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

@@ -437 +437 @@
             doRelease();
         }
-        /** Restores the number of callers after by #release(). #rc() must be
+        /** Restores the number of callers after by #release(). #hrc() must be
          *  rechecked to ensure the operation succeeded. */
         void addYY()
@@ -445 +445 @@
         }
         /** Returns the result of Console::addVMCaller() */
+        HRESULT hrc() const { return mRC; }
+        /** Returns the result of Console::addVMCaller()
+         * @deprecated Use #hrc() instead.  */
         HRESULT rc() const { return mRC; }
-        /** Shortcut to SUCCEEDED(rc()) */
+        /** Shortcut to SUCCEEDED(hrc()) */
         bool isOk() const { return SUCCEEDED(mRC); }
     protected:
@@ -471 +474 @@
      *  <code>
      *      AutoVMCaller autoVMCaller(this);
-     *      if (FAILED(autoVMCaller.rc())) return autoVMCaller.rc();
+     *      if (FAILED(autoVMCaller.hrc())) return autoVMCaller.hrc();
      *      ...
      *      VMR3ReqCall (mpUVM, ...
@@ -540 +543 @@
 
         /** The combined result of Console::addVMCaller() and Console::safeVMPtrRetainer */
-        HRESULT rc() const { return Base::isOk()? mRC: Base::rc(); }
-        /** Shortcut to SUCCEEDED(rc()) */
+        HRESULT hrc() const { return Base::isOk() ? mRC : Base::hrc(); }
+        /** The combined result of Console::addVMCaller() and Console::safeVMPtrRetainer
+         * @deprecated Use hrc() instead.  */
+        HRESULT rc() const { return Base::isOk() ? mRC : Base::hrc(); }
+        /** Shortcut to SUCCEEDED(hrc()) */
         bool isOk() const { return SUCCEEDED(mRC) && Base::isOk(); }
 
@@ -569 +575 @@
      *      Console::SafeVMPtr ptrVM(mParent);
      *      if (!ptrVM.isOk())
-     *          return ptrVM.rc();
+     *          return ptrVM.hrc();
      *      ...
      *      VMR3ReqCall(ptrVM.rawUVM(), ...
@@ -588 +594 @@
      *  <code>
      *      Console::SafeVMPtrQuiet pVM(mParent);
-     *      if (pVM.rc())
+     *      if (pVM.hrc())
      *          VMR3ReqCall(pVM, ...
      *      return S_OK;

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

@@ -418 +418 @@
         /** Session timeout (in ms). */
         uint32_t                    mTimeout;
-        /** The last returned session status
-         *  returned from the guest side. */
-        int                         mRC;
+        /** The last returned session VBox status status returned from the guest side. */
+        int                         mVrc;
         /** Object ID allocation bitmap; clear bits are free, set bits are busy. */
         uint64_t                    bmObjectIds[VBOX_GUESTCTRL_MAX_OBJECTS / sizeof(uint64_t) / 8];
@@ -443 +442 @@
             , mProtocolVersion(rThat.mProtocolVersion)
             , mTimeout(rThat.mTimeout)
-            , mRC(rThat.mRC)
+            , mVrc(rThat.mVrc)
         {
             memcpy(&bmObjectIds, &rThat.bmObjectIds, sizeof(bmObjectIds));