Expand Minimize

Verify the CheckOutType before checking out an item

When you check out an item in SharePoint, make sure that it is not already checked out.

CheckId SPC019005
TypeName CheckFileCheckoutStatusBeforeCheckOut
Severity Warning
Type Assembly

Bad Practice

using (var context = new ClientContext("http://yoursite"))
{
    var list = context.Web.Lists.GetByTitle("Documents");
    var listItem = list.GetItemById(1);
    context.Load(list);
    context.Load(listItem, i => i.File);
    context.ExecuteQuery();

    listItem.File.CheckOut();
    context.ExecuteQuery();
}

Good Practice
using (var context = new ClientContext("http://yoursite"))
{
    var list = context.Web.Lists.GetByTitle("Documents");
    var listItem = list.GetItemById(1);
    context.Load(list);
    context.Load(listItem, i => i.File);
    context.ExecuteQuery();

    if (listItem.File.CheckOutType == CheckOutType.None)
    {
        listItem.File.CheckOut();
        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", "SPC019005:CheckFileCheckoutStatusBeforeCheckOut", 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.