del método IBackupRestore.OnPrepareBackup

Artículo
05/13/2015

Proporciona la preparación del procesamiento antes de una copia de seguridad.

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

Sintaxis

'Declaración
Function OnPrepareBackup ( _
    sender As Object, _
    args As SPBackupInformation _
) As Boolean
'Uso
Dim instance As IBackupRestore
Dim sender As Object
Dim args As SPBackupInformation
Dim returnValue As Boolean

returnValue = instance.OnPrepareBackup(sender, _
    args)

bool OnPrepareBackup(
    Object sender,
    SPBackupInformation args
)

Parámetros

sender
Tipo: System.Object

El objeto que llama a OnPrepareBackup.

args
Tipo: Microsoft.SharePoint.Administration.Backup.SPBackupInformation

Un objeto SPBackupInformation que contiene datos acerca de la operación.

Valor devuelto

Tipo: System.Boolean
true si es correcto; en caso contrario, false.

Comentarios

Un objetivo principal de OnPrepareBackup es utilizar el método SetParameter() para establecer los parámetros del objeto SPBackupInformation (args) para que se pueden usar por controladores de eventos posteriores, especialmente OnPreRestore y OnRestore.

Algunos ejemplos de lo que pueden realizarse en OnPrepareBackup:

Siempre se establece el parámetro SPName de args con el valor de la propiedad Name .
Si el componente de contenido representado por el objeto IBackupRestore es algún tipo de base de datos, OnPrepareBackup puede utilizarse para especificar la información de configuración necesaria para conectarse con la aplicación de base de datos.
Si el componente de contenido representado por el objeto IBackupRestore se duplica en cada servidor Front-End, OnPrepareBackup puede utilizarse para especificar qué servidor que será el origen de la operación de copia de seguridad. Establezca el parámetro SPServer con la dirección URL del servidor elegido tal como se muestra en este ejemplo:
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL");
```
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL")
```
Si su implementación de OnPrepareBackup toma una parte importante del tiempo total para la operación de copia de seguridad, establezca args.CurrentProgess() a un valor apropiado.

Importante

No detener o pausar un servicio o aplicación Web en el método OnPrepareBackup . Vea OnBackup(Object, SPBackupInformation) por qué.

El método OnPrepareBackup siempre se ejecutará cuando se ha seleccionado el objeto IBackupRestore para copia de seguridad. Si devuelve false, se ejecutarán ni el OnBackup ni los métodos de OnBackupComplete .

Ejemplos

En el siguiente ejemplo se muestra una implementación mínima de OnPrepareBackup, que a menudo es todo lo que es necesario

public Boolean OnPrepareBackup(Object sender, SPBackupInformation args)
{
    if (args == null)
    }
        throw new ArgumentNullException("args");
    }
    args.SetParameter(SPBackupRestoreObject.SPName, this.Name);
    return true;
}

Public Function OnPrepareBackup(ByVal sender As Object, ByVal args As SPBackupInformation) As Boolean
    If args Is Nothing Then
        Throw New ArgumentNullException("args")
    End If
    args.SetParameter(SPBackupRestoreObject.SPName, Me.Name)
    Return True
End Function

Vea también

Referencia

interfaz IBackupRestore

Miembros IBackupRestore

Espacio de nombres Microsoft.SharePoint.Administration.Backup

Compartir a través de