SPFile.SendToOfficialFile 方法 (String, String)

将该文件发送到一个记录存储库，并指定记录路由类型的名称。

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

语法

声明
Public Function SendToOfficialFile ( _
    recordSeries As String, _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
用法
Dim instance As SPFile
Dim recordSeries As String
Dim additionalInformation As String
Dim returnValue As OfficialFileResult

returnValue = instance.SendToOfficialFile(recordSeries, _
    additionalInformation)

public OfficialFileResult SendToOfficialFile(
    string recordSeries,
    out string additionalInformation
)

参数

recordSeries
类型：System.String

System.String值，其中包含一种记录路由类型的名称。

additionalInformation
类型：System.String

当此方法返回时，包含提供详细的信息以响应此请求记录中心 Web 服务返回的System.String 。不经初始化就传递此参数。有关详细信息，请参阅Records Center Web Service Methods。

返回值

类型：Microsoft.SharePoint.OfficialFileResult
OfficialFileResult 枚举值。

备注

此方法将提交在记录中心中存档的文件。有关详细信息，请参阅Records Center Overview。

如果记录中心 Web 服务配置当前 Web 应用程序，用户可以用鼠标右键单击文档库中的，并发送到记录中心从菜单中选择编辑控制块。您可以使用SendToOfficialFile方法来自动执行相同的操作，可能在事件处理程序或工作流的一部分。

如果 Web 服务返回OfficialFileResult.MoreInformation，则详细的信息将被输出到additionalInformation参数中指定的变量。

示例

此示例演示如何将文件发送到官方记录存储库。

public void ArchiveFile(SPFile file)
{
    String recordSeries = file.Item.ContentType.Name;
    String additionalInformation = null;
    OfficialFileResult returnValue;

    // WSS needs the file to be checked in to know which version to send.
    if (file.Level == SPFileLevel.Checkout)
    {
        file.CheckIn(String.Empty, SPCheckinType.MinorCheckIn);
    } 
    
    returnValue = file.SendToOfficialFile(recordSeries, out additionalInformation);

    // Custom code for handling the response from the service.
    switch (returnValue)
    {
        case OfficialFileResult.MoreInformation:
            // Notify user.
            break;
        case OfficialFileResult.Success:
            //Notify user.
            break;
        default:
            // Handle error.
            break;
    }
}

Public Sub ArchiveFile(ByRef file As SPFile)

    Dim recordSeries As String = file.Item.ContentType.Name
    Dim additionalInformation As String = null
    Dim returnValue As OfficialFileResult

    ' WSS needs the file to be checked in to know which version to send.
    If file.Level = SPFileLevel.Checkout Then
        file.CheckIn(String.Empty, SPCheckinType.MinorCheckIn)
    End If

    returnValue = file.SendToOfficialFile(recordSeries, additionalInformation)

    ' Custom code for handling the response from the service.
    Select Case returnValue
        Case OfficialFileResult.MoreInformation
            ' notify user
        Case OfficialFileResult.Success
            'notify user
        Case Else
            ' handle error
    End Select
End Sub