SPFile.ScheduleEnd method

Artigo
05/12/2015

Define a data em que um arquivo será removido do exibições públicas de uma biblioteca de documentos.

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

Syntax

'Declaração
Public Sub ScheduleEnd ( _
    endDate As DateTime _
)
'Uso
Dim instance As SPFile
Dim endDate As DateTime

instance.ScheduleEnd(endDate)

public void ScheduleEnd(
    DateTime endDate
)

Parâmetros

endDate
Type: System.DateTime

Um valor de DateTime que especifica quando o arquivo deve ser cancelado (removido exibições públicas).

Exceptions

Exception	Condition
UnauthorizedAccessException	O usuário atual não tem a permissão de.ApproveItems de SPBasePermissions.
SPException	O valor da propriedade de EnableModeration de biblioteca de documentos é false.
SPException	O valor da propriedade de EnableMinorVersions de biblioteca de documentos é false.

Comentários

Esse método agenda a data e hora quando o arquivo é removido do exibições públicas.

Para garantir que o conteúdo nunca expira, passe MaxValue como o valor do parâmetro endDate .

Examples

Este exemplo define a data de expiração para um arquivo para um número especificado de dias a partir da data presente.

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