Expand Minimize

Do not dispose SPSite returned by SPControl.GetContextSite

If SPSite is obtained from the SharePoint context objects (GetContextSite method), the calling application should not call the Dispose method on the object.

CheckId SPC110244
TypeName DoNotDisposeSPSiteCreatedBySPControlGetContextSite
Severity CriticalWarning
Type Assembly

If the SPSite object is obtained from the SharePoint context objects (GetContextSite method), the calling application should not call the Dispose method on the object. Doing so may cause the SharePoint object model to behave unpredictably or fail. This is due to an internal list that is kept in the SPSite and SPWeb objects derived in this way. Internally, the object model enumerates over this list after page completion to dispose of the objects properly. See sample from MSDN:
Bad Practice

void SPControlBADPractice()
{
  SPSite site = SPControl.GetContextSite(Context);
  site.Dispose();  // DO NOT DO THIS.
}

Rule relates to SPDisposeCheckId 'SPDisposeCheckID_210'. To ignore this rule add the attribute '[SPDisposeCheckIgnore(SPDisposeCheckID.SPDisposeCheckID_210, "Caller will dispose")]' to your method.

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.MemoryDisposalGroup", "SPC110244:DoNotDisposeSPSiteCreatedBySPControlGetContextSite", 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.