SPC110245: Do not dispose SPWeb returned by SPControl.GetContextWeb

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

TypeName: DoNotDisposeSPWebCreatedBySPControlGetContextWeb
CheckId: SPC110245
Severity: CriticalWarning
Type: AssemblyFileReference
Resolution

If the SPWeb object is obtained from the SharePoint context objects (GetContextWeb 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 Coding Practice

void SPControlBADPractice()
{
  SPWeb web = SPControl.GetContextWeb(Context);
  web.Dispose();  // DO NOT DO THIS.
}

Remarks

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

Links

comments powered by Disqus