Changeset 95140 in vbox for trunk/src/VBox/Frontends/VBoxHeadless/VBoxHeadless.cpp

Timestamp:

May 31, 2022 9:11:39 AM (3 years ago)

Author:

vboxsync

Message:

Frontends + Main: Adjust to the new rules wrt. to rc -> hrc,vrc usage. This also fixes quite a few bugs wrt shadow variables, wrong return values and output error translations / exit codes. Also see @todos added. ​​bugref:10223

File:

• trunk/src/VBox/Frontends/VBoxHeadless/VBoxHeadless.cpp (modified) (17 diffs)

trunk/src/VBox/Frontends/VBoxHeadless/VBoxHeadless.cpp

@@ -992 +992 @@
     }
 
-    HRESULT rc;
-    int irc;
-
-    rc = com::Initialize();
+    HRESULT hrc;
+    int vrc;
+
+    hrc = com::Initialize();
 #ifdef VBOX_WITH_XPCOM
-    if (rc == NS_ERROR_FILE_ACCESS_DENIED)
+    if (hrc == NS_ERROR_FILE_ACCESS_DENIED)
     {
         char szHome[RTPATH_MAX] = "";
@@ -1005 +1005 @@
     }
 #endif
-    if (FAILED(rc))
+    if (FAILED(hrc))
     {
         RTPrintf("VBoxHeadless: ERROR: failed to initialize COM!\n");
@@ -1022 +1022 @@
     do
     {
-        rc = pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
-        if (FAILED(rc))
+        hrc = pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
+        if (FAILED(hrc))
         {
             RTPrintf("VBoxHeadless: ERROR: failed to create the VirtualBoxClient object!\n");
@@ -1029 +1029 @@
             if (!info.isFullAvailable() && !info.isBasicAvailable())
             {
-                com::GluePrintRCMessage(rc);
+                com::GluePrintRCMessage(hrc);
                 RTPrintf("Most likely, the VirtualBox COM server is not running or failed to start.\n");
             }
@@ -1037 +1037 @@
         }
 
-        rc = pVirtualBoxClient->COMGETTER(VirtualBox)(virtualBox.asOutParam());
-        if (FAILED(rc))
-        {
-            RTPrintf("Failed to get VirtualBox object (rc=%Rhrc)!\n", rc);
+        hrc = pVirtualBoxClient->COMGETTER(VirtualBox)(virtualBox.asOutParam());
+        if (FAILED(hrc))
+        {
+            RTPrintf("Failed to get VirtualBox object (rc=%Rhrc)!\n", hrc);
             break;
         }
-        rc = pVirtualBoxClient->COMGETTER(Session)(session.asOutParam());
-        if (FAILED(rc))
-        {
-            RTPrintf("Failed to get session object (rc=%Rhrc)!\n", rc);
+        hrc = pVirtualBoxClient->COMGETTER(Session)(session.asOutParam());
+        if (FAILED(hrc))
+        {
+            RTPrintf("Failed to get session object (rc=%Rhrc)!\n", hrc);
             break;
         }
@@ -1053 +1053 @@
         {
             CHECK_ERROR(virtualBox, SetSettingsSecret(Bstr(pcszSettingsPw).raw()));
-            if (FAILED(rc))
+            if (FAILED(hrc))
                 break;
         }
@@ -1065 +1065 @@
         ComPtr<IMachine> m;
 
-        rc = virtualBox->FindMachine(Bstr(pcszNameOrUUID).raw(), m.asOutParam());
-        if (FAILED(rc))
-        {
-            LogError("Invalid machine name or UUID!\n", rc);
+        hrc = virtualBox->FindMachine(Bstr(pcszNameOrUUID).raw(), m.asOutParam());
+        if (FAILED(hrc))
+        {
+            LogError("Invalid machine name or UUID!\n", hrc);
             break;
         }
@@ -1093 +1093 @@
         }
         Bstr bstrVMId;
-        rc = m->COMGETTER(Id)(bstrVMId.asOutParam());
-        AssertComRC(rc);
-        if (FAILED(rc))
+        hrc = m->COMGETTER(Id)(bstrVMId.asOutParam());
+        AssertComRC(hrc);
+        if (FAILED(hrc))
             break;
         g_strVMUUID = bstrVMId;
 
         Bstr bstrVMName;
-        rc = m->COMGETTER(Name)(bstrVMName.asOutParam());
-        AssertComRC(rc);
-        if (FAILED(rc))
+        hrc = m->COMGETTER(Name)(bstrVMName.asOutParam());
+        AssertComRC(hrc);
+        if (FAILED(hrc))
             break;
         g_strVMName = bstrVMName;
@@ -1255 +1255 @@
                             RTPrintf("Error: Invalid VRDE property '%s'\n", aVRDEProperties[i]);
                             RTStrFree(pszProperty);
-                            rc = E_INVALIDARG;
+                            hrc = E_INVALIDARG;
                             break;
                         }
@@ -1263 +1263 @@
                     {
                         RTPrintf("Error: Failed to allocate memory for VRDE property '%s'\n", aVRDEProperties[i]);
-                        rc = E_OUTOFMEMORY;
+                        hrc = E_OUTOFMEMORY;
                         break;
                     }
                 }
-                if (FAILED(rc))
+                if (FAILED(hrc))
                     break;
             }
@@ -1329 +1329 @@
             CHECK_ERROR_BREAK(console, PowerUpPaused(progress.asOutParam()));
 
-        rc = showProgress(progress);
-        if (FAILED(rc))
+        hrc = showProgress(progress);
+        if (FAILED(hrc))
         {
             com::ProgressErrorInfo info(progress);
@@ -1349 +1349 @@
          */
         RTTHREAD hThrMsg;
-        irc = RTThreadCreate(&hThrMsg,
-                            windowsMessageMonitor, NULL,
-                            0, /* :cbStack */
-                            RTTHREADTYPE_MSG_PUMP, 0,
-                            "MSG");
-        if (RT_FAILURE(irc))    /* not fatal */
-            LogRel(("VBoxHeadless: failed to start windows message monitor: %Rrc\n", irc));
+        vrc = RTThreadCreate(&hThrMsg,
+                             windowsMessageMonitor, NULL,
+                             0, /* :cbStack */
+                             RTTHREADTYPE_MSG_PUMP, 0,
+                             "MSG");
+        if (RT_FAILURE(vrc))    /* not fatal */
+            LogRel(("VBoxHeadless: failed to start windows message monitor: %Rrc\n", vrc));
 #endif /* RT_OS_WINDOWS */
 
@@ -1365 +1365 @@
         for (;;)
         {
-            irc = gEventQ->processEventQueue(RT_INDEFINITE_WAIT);
+            vrc = gEventQ->processEventQueue(RT_INDEFINITE_WAIT);
 
             /*
@@ -1373 +1373 @@
             if (g_fTerminateFE)
             {
-                LogRel(("VBoxHeadless: processEventQueue: %Rrc, termination requested\n", irc));
-                break;
-            }
-
-            if (RT_FAILURE(irc))
-            {
-                LogRel(("VBoxHeadless: processEventQueue: %Rrc\n", irc));
-                RTMsgError("event loop: %Rrc", irc);
+                LogRel(("VBoxHeadless: processEventQueue: %Rrc, termination requested\n", vrc));
+                break;
+            }
+
+            if (RT_FAILURE(vrc))
+            {
+                LogRel(("VBoxHeadless: processEventQueue: %Rrc\n", vrc));
+                RTMsgError("event loop: %Rrc", vrc);
                 break;
             }
@@ -1409 +1409 @@
     if (!machine.isNull())
     {
-        rc = machine->COMGETTER(State)(&machineState);
-        if (SUCCEEDED(rc))
+        hrc = machine->COMGETTER(State)(&machineState);
+        if (SUCCEEDED(hrc))
             Log(("machine state = %RU32\n", machineState));
         else
-            Log(("IMachine::getState: %Rhrc\n", rc));
+            Log(("IMachine::getState: %Rhrc\n", hrc));
     }
     else
@@ -1440 +1440 @@
             CHECK_ERROR_BREAK(gConsole, PowerDown(pProgress.asOutParam()));
 
-        rc = showProgress(pProgress);
-        if (FAILED(rc))
+        hrc = showProgress(pProgress);
+        if (FAILED(hrc))
         {
             com::ErrorInfo info;
             if (!info.isFullAvailable() && !info.isBasicAvailable())
-                com::GluePrintRCMessage(rc);
+                com::GluePrintRCMessage(hrc);
             else
                 com::GluePrintErrorInfo(info);
@@ -1518 +1518 @@
 
     LogRel(("VBoxHeadless: exiting\n"));
-    return FAILED(rc) ? 1 : 0;
+    return SUCCEEDED(hrc) ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
 }