Fix RCW error (ReleaseComObject only if loaded by Add-in)

Author: josef-poetzl

access-add-in/AccUnitLoader.accda

@@ -18,7 +18,7 @@ Option Compare Text
 Option Explicit
 
 'Version number
-Private Const APPLICATION_VERSION As String = "0.9.800.240510"
+Private Const APPLICATION_VERSION As String = "0.9.1000.240519"
 
 Private Const APPLICATION_NAME As String = "ACLib AccUnit Loader"
 Private Const APPLICATION_FULLNAME As String = "Access Code Library - AccUnit Loader"

access-add-in/source/modules/_config_Application.bas

@@ -19,7 +19,7 @@ Option Explicit
 Option Private Module
 
 'Version number
-Private Const APPLICATION_VERSION As String = "0.9.900.2400512"
+Private Const APPLICATION_VERSION As String = "0.9.1000.240519"
 
 Private Const APPLICATION_NAME As String = "ACLib AccUnit Loader"
 Private Const APPLICATION_FULLNAME As String = "Access Code Library - AccUnit Loader"

excel-add-in/AccUnitLoader.xlam

@@ -25,8 +25,8 @@ public enum AcCommand { AcCmdCompileAndSaveAllModules = 126 };
 
         public enum AcObjectType { AcDefault = -1, AcTable = 0, AcQuery = 1, AcForm = 2, AcReport = 3, AcMacro = 4, AcModule = 5 };
 
-        public AccessApplicationHelper(object application)
-            : base(application)
+        public AccessApplicationHelper(object application, bool releaseApplicationComObjectOnDispose = false)
+            : base(application, releaseApplicationComObjectOnDispose)
         {
         }
 

excel-add-in/source/AccUnitLoaderForm.frx

@@ -87,7 +87,7 @@ private static Type GetAccessApplicationTypeForComObject(object accessComObject)
             }
         }
 
-        public static OfficeApplicationHelper GetOfficeApplicationHelper(VBE vbe, ref object hostApplication)
+        public static OfficeApplicationHelper GetOfficeApplicationHelper(VBE vbe, ref object hostApplication, bool releaseApplicationComObjectOnDispose = false)
         {
             using (new BlockLogger())
             {
@@ -101,19 +101,19 @@ public static OfficeApplicationHelper GetOfficeApplicationHelper(VBE vbe, ref ob
                     isAccessApplication = GetAccessApplicationTypeForComObject(hostApplication) != null;
                 }
 
-                return hostApplication is null ? new VbeOnlyApplicatonHelper(vbe) : GetOfficeApplicationHelper(hostApplication, isAccessApplication);
+                return hostApplication is null ? new VbeOnlyApplicatonHelper(vbe) : GetOfficeApplicationHelper(hostApplication, isAccessApplication, releaseApplicationComObjectOnDispose);
             }
         }
 
-        private static OfficeApplicationHelper GetOfficeApplicationHelper(object hostApplication, bool isAccessApplication)
+        private static OfficeApplicationHelper GetOfficeApplicationHelper(object hostApplication, bool isAccessApplication, bool releaseApplicationComObjectOnDispose)
         {
             using (new BlockLogger())
             {
                 OfficeApplicationHelper applicationHelper;
                 if (isAccessApplication)
                 {
                     Logger.Log("Access application");
-                    applicationHelper = new AccessApplicationHelper(hostApplication);
+                    applicationHelper = new AccessApplicationHelper(hostApplication, releaseApplicationComObjectOnDispose);
                 }
                 else
                 {

excel-add-in/source/AccUnitUserSettings.frx

@@ -22,6 +22,7 @@ public class OfficeApplicationHelper : IOfficeApplicationHelper, IDisposable
     {
         private object _application;
         private InvocationHelper _invocationHelper;
+        private bool _releaseApplicationComObjectOnDispose;
 
         public object Application { get { return _application; } }
         protected InvocationHelper InvocationHelper { get { return _invocationHelper; } }
@@ -38,10 +39,11 @@ public string Name
             }
         }
 
-        public OfficeApplicationHelper(object application)
+        public OfficeApplicationHelper(object application, bool releaseApplicationComObjectOnDispose = false)
         {
             _application = application ?? throw new ArgumentNullException();
             _invocationHelper = new InvocationHelper(application);
+            _releaseApplicationComObjectOnDispose = releaseApplicationComObjectOnDispose;   
         }
 
         public virtual VBE VBE
@@ -140,7 +142,10 @@ protected virtual void Dispose(bool disposing)
 
                 if (_application != null)
                 {
-                    Marshal.ReleaseComObject(_application); 
+                    if (_releaseApplicationComObjectOnDispose)
+                    {
+                        Marshal.ReleaseComObject(_application);
+                    }
                     _application = null;
                 }   
 
@@ -150,13 +155,11 @@ protected virtual void Dispose(bool disposing)
                 Logger.Log(ex.Message);
             }
 
-            // GC-Bereinigung wegen unmanaged res:
-            /*
+            // GC clean up
             GC.Collect();
             GC.WaitForPendingFinalizers();
             GC.Collect();
             GC.WaitForPendingFinalizers();
-            */
             _disposed = true;
         }
 

excel-add-in/source/config_Application.bas

@@ -48,7 +48,6 @@ public AddInManager(AddIn addIn)
 
                 /*
                 _tagListManager.AddIn = addIn;
-                _testListAndResultManager.AddIn = addIn;
                 */
 
                 InitOfficeApplicationHelper();
@@ -266,8 +265,8 @@ private void InitOfficeApplicationHelper(object hostApplication = null)
         {
             using (new BlockLogger())
             {
-                // Note: if load RubberDuck, an instance of Access stay in memory after close
-                _officeApplicationHelper = HostApplicationTools.GetOfficeApplicationHelper(VBE, ref hostApplication);
+                // Note: if load RubberDuck, an instance of Access stay in memory after close => HostApplicationTools.GetOfficeApplicationHelper(..., ..., true);
+                _officeApplicationHelper = HostApplicationTools.GetOfficeApplicationHelper(VBE, ref hostApplication, true);
                 _vbeIntegrationManager.OfficeApplicationHelper = _officeApplicationHelper;
                 _testSuiteManager.OfficeApplicationHelper = _officeApplicationHelper;
             }