Dispose created SPSite objects |
When you create a SPSite object with a new operator, the creating application must dispose of it.
| CheckId | SPC110201 |
|---|---|
| TypeName | DisposeCreatedSPSiteObject |
| Severity | CriticalWarning |
| Type | Assembly |
Call Dispose on created SPSite object or wrap instruction into using statement. See sample from MSDN:
Bad Practice
CreatingSPSiteWithLeak()
{
SPSite siteCollection = new SPSite("http://moss");
// ...
// SPSite object siteCollection is leaked.
}
{
SPSite siteCollection = new SPSite("http://moss");
// ...
// SPSite object siteCollection is leaked.
}
Good Practice
void CreatingSPSiteWithAutomaticDisposeNoLeak()
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
} // SPSite object siteCollection.Dispose() is called automatically.
}
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
} // SPSite object siteCollection.Dispose() is called automatically.
}
Rule relates to SPDisposeCheckId 'SPDisposeCheckID_110'. To ignore this rule add the attribute '[SPDisposeCheckIgnore(SPDisposeCheckID.SPDisposeCheckID_110, "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", "SPC110201:DisposeCreatedSPSiteObject", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.MemoryDisposalGroup", "SPC110201:DisposeCreatedSPSiteObject", 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.