CSOM SharePoint 检查文件是否已签入

在SharePoint中，当用户签入文件时，其他用户便无法编辑该文件。在代码中，我们需要检查文件是否已经签入，从而确保在编辑或更新文件之前可以采取适当的措施。

使用SharePoint CSOM检查文件是否已签入

以下是使用SharePoint CSOM检查文件是否已签入的示例代码：

using System;
using Microsoft.SharePoint.Client;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            string siteUrl = "https://your-sharepoint-site-url";
            string documentUrl = "/shared%20documents/sample-file.docx";
            string username = "your-username";
            string password = "your-password";

            using (var context = new ClientContext(siteUrl))
            {
                context.Credentials = new SharePointOnlineCredentials(username, GetSecureString(password));

                var file = context.Web.GetFileByServerRelativeUrl(documentUrl);
                context.Load(file, f => f.Name, f => f.CheckOutType);

                try
                {
                    context.ExecuteQuery();

                    if (file.CheckOutType == CheckOutType.None)
                    {
                        Console.WriteLine("The file is not checked out.");
                    }
                    else
                    {
                        Console.WriteLine("The file is checked out.");
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine("Error: " + ex.Message);
                }
            }
        }

        private static System.Security.SecureString GetSecureString(string password)
        {
            var securePassword = new System.Security.SecureString();
            foreach (char c in password)
            {
                securePassword.AppendChar(c);
            }
            return securePassword;
        }
    }
}

解释代码

该代码使用了SharePoint CSOM（客户端对象模型）来检查文件是否已经签入。这是通过以下步骤进行的：

1. 首先，我们需要获取对SharePoint网站的访问权限。我们需要使用用户名和密码来进行身份验证。
2. 然后，我们可以通过相对URL或文件路径获取要检查的文件。我们加载文件对象并指定我们需要检查的属性（名称和签出类型）。
3. 最后，我们执行查询并检查文件签出类型的值。如果签出类型为“None”，这意味着文件没有签出。否则，文件已签出。

结论

在本文中，我们已经了解了如何使用SharePoint CSOM在代码中检查文件是否已经签入。这是一项非常有用的功能，因为它确保了对文件的协同编辑和更新，从而实现了更好的工作流程。