(String, String) del método SPFile.SendToOfficialFile

Artículo
05/13/2015

Envía el archivo a un repositorio de registros y especifica el nombre de un tipo de enrutamiento de registro.

Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
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
Tipo: System.String

valor de System.String que contiene el nombre de un tipo de distribución de registros.

additionalInformation
Tipo: System.String

Cuando este método devuelve, contiene un System.String que proporciona información detallada devuelto por el servicio Web del centro de registros en respuesta a esta solicitud. Este parámetro se pasa sin inicializar. Para obtener más información, vea Records Center Web Service Methods.

Valor devuelto

Tipo: Microsoft.SharePoint.OfficialFileResult
Un valor de enumeración OfficialFileResult .

Comentarios

Este método envía un archivo para el archivado en un centro de registros. Para obtener más información, vea Records Center Overview.

Si un servicio Web del centro de registros está configurado para la aplicación Web actual, los usuarios pueden (ratón) en un documento de una biblioteca y elija Enviar a centro de registros en el menú de bloque de control de edición. Puede usar el método SendToOfficialFile para automatizar la misma operación, quizás en un controlador de eventos o como parte de un flujo de trabajo.

Si el servicio Web devuelve OfficialFileResult.MoreInformation, información detallada es el resultado a la variable denominada en el argumento para el parámetro additionalInformation .

Ejemplos

En este ejemplo se muestra cómo enviar un archivo en el repositorio de registros oficiales.

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