SPFile.ScheduleEnd-Methode

Artikel
05/06/2015

Legt das Datum, an dem eine Datei aus öffentlichen Ansichten einer Dokumentbibliothek entfernt wird.

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

Syntax

'Declaration
Public Sub ScheduleEnd ( _
    endDate As DateTime _
)
'Usage
Dim instance As SPFile
Dim endDate As DateTime

instance.ScheduleEnd(endDate)

public void ScheduleEnd(
    DateTime endDate
)

Parameter

endDate
Typ: System.DateTime

Ein DateTime -Wert, der angibt, wann die Datei aufgehoben werden sollte (von öffentlichen Ansichten entfernt).

Ausnahmen

Ausnahme	Bedingung
UnauthorizedAccessException	Der aktuelle Benutzer keinen die SPBasePermissions.ApproveItems -Berechtigung.
SPException	Der Wert der Eigenschaft EnableModeration Document Library ist false.
SPException	Der Wert der Eigenschaft EnableMinorVersions Document Library ist false.

Hinweise

Diese Methode plant, Datum und Uhrzeit, wann die Datei von öffentlichen Ansichten entfernt wird.

Um sicherzustellen, dass der Inhalt nie abläuft, übergeben Sie MaxValue als den Wert des Parameters endDate .

Beispiele

In diesem Beispiel wird das Ablaufdatum für eine Datei mit einer angegebenen Anzahl von Tagen ab dem aktuellen Datum.

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