Expand Minimize

SPC019024: Ensure you are calling Web.Update() before ClientContext.ExecuteQuery() when modifying a Web object.

When modifying a Web object, ensure you are calling Web.Update() before ClientContext.ExecuteQuery() in order to persist the changes to the object.

CheckId SPC019024
TypeName EnsureWebUpdateBeforeExecuteQuery
Severity Warning
Type Assembly

Bad Practice

    using (var context = new ClientContext("http://yoursite"))
    {
        Web web = context.Web;
        web.Title = "My Web Title";
        web.Description = "My New Web Description";
        context.ExecuteQuery();
    }


Good Practice
    using (var context = new ClientContext("http://yoursite"))
    {
        Web web = context.Web;
        web.Title = "My Web Title";
        web.Description = "My Web Description";
        web.Update();
        context.ExecuteQuery();
    }

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.ManagedCSOM.CSOMCorrectnessGroup", "SPC019024:EnsureWebUpdateBeforeExecuteQuery", 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.