SPFile.SendToOfficialFile method (String, String)

Artigo
05/12/2015

Envia o arquivo para um repositório de registros e especifica o nome de um tipo de roteamento do registro.

Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaração
Public Function SendToOfficialFile ( _
    recordSeries As String, _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
'Uso
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
)

Parâmetros

recordSeries
Type: System.String

System.String valor que contém o nome de um tipo de registro de roteamento.

additionalInformation
Type: System.String

Quando esse método retorna, contém um System.String que fornece informações detalhadas retornadas pelo serviço Web da Central de registros em resposta a essa solicitação. Este parâmetro é passado não inicializado. Para obter mais informações, consulte Records Center Web Service Methods.

Valor retornado

Type: Microsoft.SharePoint.OfficialFileResult
Um valor de enumeração de OfficialFileResult .

Comentários

Este método envia um arquivo para arquivamento em uma central de registros. Para obter mais informações, consulte Records Center Overview.

Se um serviço Web da Central de registros está configurado para o aplicativo da Web atual, os usuários podem do mouse em um documento em uma biblioteca e escolha Enviar para a Central de registros no menu de bloco de controle de edição. Você pode usar o método SendToOfficialFile para automatizar a mesma operação, talvez em um manipulador de eventos ou como parte de um fluxo de trabalho.

Se o serviço da Web retorna OfficialFileResult.MoreInformation, informações detalhadas serão enviado para a variável nomeada no argumento para o parâmetro additionalInformation .

Examples

Este exemplo mostra como enviar um arquivo para o repositório de registros oficiais.

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