SPFile.ScheduleEnd - Méthode

Article
05/12/2015

Définit la date à laquelle un fichier sera retiré des affichages publics d'une bibliothèque de documents.

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

Syntaxe

'Déclaration
Public Sub ScheduleEnd ( _
    endDate As DateTime _
)
'Utilisation
Dim instance As SPFile
Dim endDate As DateTime

instance.ScheduleEnd(endDate)

public void ScheduleEnd(
    DateTime endDate
)

Paramètres

endDate
Type : System.DateTime

Une valeur DateTime qui spécifie si le fichier doit être non publié (supprimé de vues publiques).

Exceptions

Exception	Condition
UnauthorizedAccessException	L'utilisateur actuel ne dispose pas de l'autorisation de.ApproveItemsSPBasePermissions.
SPException	La valeur de la propriété EnableModeration de bibliothèque de documents est false.
SPException	La valeur de la propriété EnableMinorVersions de bibliothèque de documents est false.

Remarques

Cette méthode permet de planifier la date et l'heure lorsque le fichier est supprimé à partir d'affichages publics.

Pour vous assurer que le contenu n'expire jamais, transmettez MaxValue comme la valeur du paramètre endDate .

Exemples

Cet exemple définit la date d'expiration pour un fichier à un nombre spécifié de jours à partir de la date actuelle.

public void Retire(SPFile file, double days)
{
    // Set an expiration date only after content has been published.
    if ((file != null) && (file.Level == SPFileLevel.Published))
    {
        try
        {
            file.ScheduleEnd(DateTime.Now.AddDays(days));
        }
        catch (SPException ex)
        {
            // error handling
        }
    }
    else
    {
        throw new Exception("A file must be published before you can schedule it for retirement.");
    }
}

Public Sub Retire(ByRef file As SPFile, ByVal days As Double)

    'Set an expiration date only after content has been published.
    If (file Is Nothing) And (file.Level = SPFileLevel.Published) Then

        Try

            file.ScheduleEnd(DateTime.Now.AddDays(days))

        Catch ex As SPException

            ' error handling

        End Try

    Else

        Throw New Exception("A file must be published before you can schedule it for retirement.")

    End If

End Sub