Dispose SPWeb objects created with SPSite.OpenWeb |
The OpenWeb method 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 | SPC110203 |
|---|---|
| TypeName | DisposeSPWebCreatedByOpenWeb |
| Severity | CriticalWarning |
| Type | Assembly |
Call Dispose on created SPWeb object or wrap instruction into using statement. See sample from MSDN:
Bad Practice
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
SPWeb web = siteCollection.OpenWeb();
// SPWeb object web leaked.
} // SPSite object siteCollection.Dispose() automatically called.
}
Good Practice
{
using (SPSite siteCollection = new SPSite("http://moss"))
{
using (SPWeb web = siteCollection.OpenWeb())
{
} // SPWeb object web.Dispose() automatically called.
} // SPSite object siteCollection.Dispose() automatically called.
}
Rule relates to SPDisposeCheckId 'SPDisposeCheckID_120'. To ignore this rule add the attribute '[SPDisposeCheckIgnore(SPDisposeCheckID.SPDisposeCheckID_120, "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", "SPC110203:DisposeSPWebCreatedByOpenWeb", Justification = "Provide reason for suppression here")]