Share via


SPFile.CheckIn - Méthode (String)

Vérifie dans le fichier dans une bibliothèque de documents avec le commentaire spécifié.

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

Syntaxe

'Déclaration
Public Sub CheckIn ( _
    comment As String _
)
'Utilisation
Dim instance As SPFile
Dim comment As String

instance.CheckIn(comment)
public void CheckIn(
    string comment
)

Paramètres

  • comment
    Type : System.String

    Une chaîne contenant un commentaire sur l'archivage.

Exceptions

Exception Condition
SPException

Une erreur s'est produite lors de la vérification dans le fichier.

Remarques

Cette méthode appelle CheckIn(String, SPCheckinType) avec le second argument défini sur MinorCheckIn.

Bien qu'un commentaire d'archivage n'est pas requis dans l'interface utilisateur, la méthode CheckIn nécessite un commentaire, qui peut être une chaîne vide, comme son paramètre.

Si le contrôle de version est activé pour la bibliothèque de documents qui contient le fichier, la méthode CheckIn crée un objet SPFileVersion .

Exemples

L'exemple de code suivant vérifie la sauvegarde de fichiers dans la bibliothèque de documents Documents partagés d'un sous-site Web si l'utilisateur spécifié est celui qui a extrait les.

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");
        }
    }
}

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Voir aussi

Référence

SPFile classe

SPFile - Membres

CheckIn - Surcharge

Microsoft.SharePoint - Espace de noms