Outlook and .Net

If you are developing an addin for Outlook in C# or another .Net language or even just using COM from .Net, you should be cleaning up your COM objects (duh!). But, setting them to null is not enough. You must use the System.Runtime.InteropServices.Marshal.ReleaseComObject method to remove all references to that COM object. Here's a little class that you can use so you don't have to retype the code all over the place.

using System;
using System.Runtime.InteropServices;
namespace Utils{
    public class ComUtils {
        public ComUtils() {

        /// <summary>
        /// Force a release of the COM objects and do garbage collection.
        /// If you are using Outlook objects, this will allow Outlook to
        /// exit cleanly after you are done with it.
        /// </summary>
        /// <param name="comObjects">Array of COM objects to release,
        /// be sure to add the objects to the array in the order you want
        /// them destroyed!</param>
        public static void Release(params object[] comObjects) {
            try {
                for(int i = 0; i<comObjects.Length;i++) {
                    if(comObjects[i] != null) {
                            // loop until the reference count is zero
                            while(Marshal.ReleaseComObject(comObjects[i]) > 0);
                            // the object was not a COM object
                            // no big deal, just go on to the next one
                            // object was null, still no big deal
                            // go on to next one
                            comObjects[i] = null;
            catch (Exception ex) {
                // insert your exception handling here
            finally {
                // force a garbage collect to occur
                // Wait for the thread processing the
                // queue of finalizers to finish

Just create an object array of your COM objects (in the order you want them released) and pass them to the Realease method of this class. For example:

ComUtils.Release(outlookMailItem, outlookNameSpace, outlookApplication)

The GC.Collect() and GC.WaitForPendingFinalizers() are very important. I was recently working on an Outlook Addin and didn't have those two lines in there. Outlook would NOT shut down completely until I added them in.

comments powered by Disqus