How to properly implement idisposable (c#)?

Question

0.00/5 (No votes)

See more:

I ran Analyze > Run Code Analysis on Solution on my C# Winforms app. I got this:

CA1001 Types that own disposable fields should be disposable Implement IDisposable on 'ExceptionLoggingService' because it creates members of the following IDisposable types: 'StreamWriter'. If 'ExceptionLoggingService' has previously shipped, adding new members that implement IDisposable to this type is considered a breaking change to existing consumers.

What I have tried:

So I added it:

C#

public class ExceptionLoggingService : IDisposable
{
	. . .

	public void Dispose()
        {
            _streamWriter.Dispose();
        }
        . . .

...but running Analyze > Run Code Analysis on Solution again gives me the following fingerwag:

CA1063 Implement IDisposable correctly Provide an overridable implementation of Dispose(bool) on 'ExceptionLoggingService' or mark the type as sealed. A call to Dispose(false) should only clean up native resources. A call to Dispose(true) should clean up both managed and native resources.

So what must I do to appease the beast?

Posted 18-Feb-16 10:10am

B. Clay Shannon

Updated 18-Feb-16 11:51am

v2

Add a Solution

Comments

BillWoodruff 18-Feb-16 17:12pm

Do you have a first-born, or a black chicken ?

B. Clay Shannon 18-Feb-16 17:18pm

I did have a firstborn.

Beginner Luck 18-Feb-16 17:23pm

try using method

B. Clay Shannon 18-Feb-16 17:25pm

All down but nine, pard; set 'em up on the other alley.

Philippe Mori 18-Feb-16 21:32pm

By the way, if you are using Visual Studio 2015, the IDE allows you to implement the interface according to the full pattern (or an empty implementation) so you don't even have to search very far...

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Andreas Gieriet · Answer 1 · 2016-02-18T11:43:00

Solution 1

Have you read this: Dispose Pattern[^]?
The message says it: make your class sealed or follow the Dispose Pattern as described in the link above.
Cheers
Andi

Posted 18-Feb-16 11:43am

Andreas Gieriet

Updated 18-Feb-16 11:49am

v2

B. Clay Shannon · Answer 2 · 2016-02-18T11:51:00

Solution 2

Thanks to Andi's link, this works:

C#

public void Dispose()
{
    Dispose(true);
    GC.SuppressFinalize(this);
}

protected virtual void Dispose(bool disposing)
{
    if (disposing)
    {
        if (_streamWriter != null) _streamWriter.Dispose();
    }
}

Posted 18-Feb-16 11:51am

B. Clay Shannon