del método SPFile.ScheduleEnd

Artículo
05/13/2015

Establece la fecha en la que se quitará un archivo de vistas públicas de una biblioteca de documentos.

Espacio de nombres: Microsoft.SharePoint
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
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
Tipo: System.DateTime

Un valor de DateTime que especifica cuándo debe publicarse el archivo (quitan vistas públicas).

Excepciones

Excepción	Condición
UnauthorizedAccessException	El usuario actual no tiene el permiso de.ApproveItemsSPBasePermissions.
SPException	El valor de la propiedad EnableModeration de biblioteca de documentos es false.
SPException	El valor de la propiedad EnableMinorVersions de biblioteca de documentos es false.

Comentarios

Este método programa la fecha y hora cuando se quita el archivo de vistas públicas.

Para asegurarse de que el contenido nunca caduca, pase MaxValue como el valor del parámetro endDate .

Ejemplos

En este ejemplo se establece la fecha de caducidad de un archivo a un número especificado de días desde la fecha actual.

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