Expand Minimize

SPM040201: SPWebConfigModifications

The metric counts the classes in assemblies with calls to web.config modifications. It counts every call to the property Microsoft.SharePoint.Administration.SPWebService.WebConfigModifications or Microsoft.SharePoint.Administration.SPWebApplication.WebConfigModifications. This includes 'add' and 'delete' of modifications.

CheckId SPM040201
TypeName ContainsSPWebConfigModifications
Severity Information
Type Assembly

The metric may also count calls to properties which are not changing the items in the collection (Count, Contains, GetType etc.) and may lead to incorrect results. The metric only counts the changes to the WebConfigModifications collection, but finally an Update() for SPWebApplication or SPWebService is necessary to apply the changes. If the Update() is not called in the code the changes are not applied and the metric leads to incorrect results

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.Metrics.FarmStabilityGroup", "SPM040201:ContainsSPWebConfigModifications", 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.