Dispose SPSite objects created with SPSite.SelfServiceCreateSite |
The SelfServiceCreateSite method (all signatures) create an SPWeb object and return it to the caller. This new object is not stored in the SPSite object and is not disposed of anywhere in the SPSite class. For this reason, you should dispose of any object created via these methods.
CheckId | SPC110204 |
---|---|
TypeName | DisposeSPSiteCreatedBySelfServiceCreateSite |
Severity | CriticalWarning |
Type | Assembly |
Call Dispose on returned SPSite object or wrap instruction into using statement. See sample from MSDN:
Bad Practice
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
SPSite site = siteCollection.SelfServiceCreateSite(...);
// SPSite object site leaked.
} // SPSite object siteCollection.Dispose() automatically called.
}
Good Practice
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
using (SPSite site = siteCollection.SelfServiceCreateSite(...))
{
} // SPSite object site.Dispose() automatically called.
} // SPSite object siteCollection.Dispose() automatically called.
}
Rule does not relate to an existing SPDisposeCheckId and defines its own ID 'SPDisposeCheckID_600'. To ignore this rule add the attribute '[SPDisposeCheckIgnore(SPDisposeCheckID.SPDisposeCheckID_600, "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.
[SuppressMessage("SPCAF.Rules.MemoryDisposalGroup", "SPC110204:DisposeSPSiteCreatedBySelfServiceCreateSite", Justification = "Provide reason for suppression here")]