SPFile.SendToOfficialFile - Méthode (String, String)

Article
05/12/2015

Envoie le fichier à un référentiel d'enregistrements et spécifie le nom d'un type de routage d'enregistrement.

Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function SendToOfficialFile ( _
    recordSeries As String, _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
'Utilisation
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
)

Paramètres

recordSeries
Type : System.String

valeur System.String qui contient le nom d'un type d'enregistrement de routage.

additionalInformation
Type : System.String

Lorsque cette méthode est retournée, contient un System.String qui propose des informations retournées par le service Web du centre enregistrements en réponse à cette demande. Ce paramètre est passé sans être initialisé. Pour plus d'informations, consultez Records Center Web Service Methods.

Valeur renvoyée

Type : Microsoft.SharePoint.OfficialFileResult
Valeur d'énumération OfficialFileResult .

Remarques

Cette méthode soumet un fichier pour l'archivage dans un centre des enregistrements. Pour plus d'informations, consultez Records Center Overview.

Si un service Web de centre d'enregistrements est configuré pour l'application Web en cours, les utilisateurs peuvent droit sur un document dans une bibliothèque et choisissez Envoyer au site Centre des enregistrements à partir du menu de bloc de contrôle edit. Vous pouvez utiliser la méthode SendToOfficialFile pour automatiser la même opération, éventuellement dans un gestionnaire d'événements ou dans le cadre d'un flux de travail.

Si le service Web retourne des OfficialFileResult.MoreInformation, des informations détaillées sont sortie à la variable nommée dans l'argument pour le paramètre additionalInformation .

Exemples

Cet exemple montre comment envoyer un fichier dans le référentiel d'enregistrements officiels.

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