Expand Minimize

You should always dispose a ClientContext.

When working with objects that implement the IDisposable interface, make sure you dispose the object properly when you are done.

CheckId SPC119001
TypeName DisposeClientContext
Severity Warning
Type Assembly

Bad Practice

ClientContext context = new ClientContext("http://yoururl");
var web = context.Web;
context.Load(web);
context.ExecuteQuery();
var webTitle = web.Title;


Good Practice
using (var context = new ClientContext("http://yoursiteurl"))
{
    // Your Code Here
}


Good Practice
ClientContext context = null;
try
{
    context = new ClientContext("http://yoururl");
    // Your Code Here
}
finally
{
    if (context != null)
    context.Dispose();
}

To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.

// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("SPCAF.Rules.ManagedCSOM.CSOMDisposal", "SPC119001:DisposeClientContext", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.