SPC050236: Do not call SPItemEventProperties.OpenWeb() |
Do not call SPItemEventProperties.OpenWeb(). Use the newly introduced SPItemEventProperties.Web property instead for better performance and to avoid the need to call Dispose().
| CheckId | SPC050236 |
|---|---|
| TypeName | DoNotCallSPItemEventPropertiesOpenWeb |
| Severity | CriticalWarning |
| Type | Assembly |
Replace calls to SPItemEventProperties.OpenWeb() with SPItemEventProperties.Web property for better performance and to avoid the need to call Dispose().
Bad Practice
public override void ItemDeleting(SPItemEventProperties properties)
{
SPWeb web = properties.OpenWeb();
// Operate on the SPWeb object which needs later Dispose.
...
}
{
SPWeb web = properties.OpenWeb();
// Operate on the SPWeb object which needs later Dispose.
...
}
Good Practice
public override void ItemDeleting(SPItemEventProperties properties)
{
SPWeb web = properties.Web;
// Operate on the SPWeb object with better performance and without need for Dispose.
...
}
{
SPWeb web = properties.Web;
// Operate on the SPWeb object with better performance and without need for Dispose.
...
}
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.BestPracticesGroup", "SPC050236:DoNotCallSPItemEventPropertiesOpenWeb", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.BestPracticesGroup", "SPC050236:DoNotCallSPItemEventPropertiesOpenWeb", 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.