Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

IDisposable Pattern

0.00/5 (No votes)
3 Oct 2008 1  
The IDisposable pattern isn't one of the a classic patterns. It's a pattern suggested in MSDN to implement the IDisposable interface. You should be

This articles was originally at wiki.asp.net but has now been given a new home on CodeProject. Editing rights for this article has been set at Bronze or above, so please go in and edit and update this article to keep it fresh and relevant.

The IDisposable pattern isn't one of the a classic patterns. It's a pattern suggested in
MSDN to implement the IDisposable interface. You should be familiar with the pattern
or with the interface because it's a basic thing to know about the .Net framework.

How to Use IDisposable Pattern
Lets look at a code example.

    public class DisposeObject : IDisposable

    {

        #region Members

 

        private bool _disposed = false;

 

        #endregion

 

        #region IDisposable Members

 

        ~DisposeObject()

        {

            Dispose(false);

        }

 

        /// <summary>

        /// Dispose the current object

        /// </summary>

        public void Dispose()

        {

            Dispose(true);

        }

 

        private void Dispose(bool disposing)

        {

            if (!_disposed)

            {

                if (disposing)

                {

                    // clean up resources

                    CleanUp();

 

                    // The object will be cleaned up only if the method

                    // gets true - we are in the Dispose method.

                    // Therefore, you should call GC.SupressFinalize to

                    // take this object off the finalization queue

                    // and prevent finalization code for this object

                    // from executing a second time.

                    // Taken from MSDN.

                    GC.SuppressFinalize(this);

                }

 

                // dispose occurred

                _disposed = true;

            }

        }

 

        private void CleanUp()

        {

            // put here the code to dispose all managed

            // and unmanaged resources

        }

 

        #endregion

    }

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here