SPFile.CheckIn 方法 (String)

项目
2015/05/13

签入文档库具有指定备注的文件。

命名空间： Microsoft.SharePoint
程序集： Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）

语法

声明
Public Sub CheckIn ( _
    comment As String _
)
用法
Dim instance As SPFile
Dim comment As String

instance.CheckIn(comment)

public void CheckIn(
    string comment
)

参数

comment
类型：System.String

一个字符串，包含有关签入的注释。

异常

异常	条件
SPException	当签入文件时出错。

备注

此方法调用第二个参数设置为MinorCheckIn与CheckIn(String, SPCheckinType) 。

虽然在用户界面中不需要签入注释， CheckIn方法将需要注释，可以为空字符串）作为其参数。

如果包含该文件的文档库启用版本控制时， CheckIn方法创建一个SPFileVersion对象。

示例

下面的代码示例检查文件回复到共享文档文档库的子网站，是否指定的用户是检出的人。

Dim site As SPSite = SPContext.Current.Site
Dim web As SPWeb = site.AllWebs("Site_Name/Subsite_Name")
Dim docLibFolder As SPFolder = web.Folders("Shared Documents")
Dim docLibFiles As SPFileCollection = docLibFolder.Files
Dim i As Integer

For i = 0 To docLibFiles.Count - 1

    If docLibFiles(i).CheckedOutBy.LoginName = "User_Name" Then

        docLibFiles(i).CheckIn("Checkin_Comment")

    End If

Next i

SPSite oSiteCollection = SPContext.Current.Site;
using(SPWeb oWebsite = oSiteCollection.AllWebs["Site_Name/Subsite_Name"])
{
    SPFolder oFolder = oWebsite.Folders["Shared Documents"];

    SPFileCollection collFiles = oFolder.Files;

    for (int intIndex=0; intIndex<oFolder.Count; intIndex++)
    {
        if (oFolder[intIndex].CheckedOutBy.LoginName == "User_Name")
        {
            oFolder[intIndex].CheckIn("Checkin_Comment");
        }
    }
}

备注

某些对象实现IDisposable接口，并必须避免后不再需要保留这些对象在内存中。好的编码做法有关的信息，请参阅Disposing Objects。