IBackupRestore.OnPrepareBackup method

Artigo
05/12/2015

Fornece preparação de processamento antes de um backup.

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

Syntax

'Declaração
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
Type: System.Object

O objeto que chama OnPrepareBackup.

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

Um objeto SPBackupInformation que contém dados sobre a operação.

Valor retornado

Type: System.Boolean
true se for bem-sucedida; Caso contrário, false.

Comentários

A principal finalidade de OnPrepareBackup é usar o método SetParameter() para definir os parâmetros do objeto SPBackupInformation (args) para que eles podem ser usados por manipuladores de evento posteriores, especialmente OnPreRestore e OnRestore.

Alguns exemplos do que pode ser feito em OnPrepareBackup:

Sempre defina o parâmetro de SPName de args com o valor da propriedade Name .
Se o componente de conteúdo representado pelo objeto IBackupRestore algum tipo de banco de dados, OnPrepareBackup pode ser usado para especificar informações de configurações necessárias para conectar-se com o aplicativo de banco de dados.
Se o componente de conteúdo representado pelo objeto IBackupRestore é duplicado em cada servidor Front-End, o OnPrepareBackup pode ser usado para especificar o servidor que será a origem da operação de backup. Defina o parâmetro SPServer com a URL do servidor escolhido como mostrado neste exemplo:
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL");
```
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL")
```
Se a sua implementação de OnPrepareBackup usa uma parte significativa do tempo total para a operação de backup, defina args.CurrentProgess() para um valor apropriado.

Importante

Não parar ou pausar um serviço ou aplicativo da Web no método OnPrepareBackup . Consulte OnBackup(Object, SPBackupInformation) para motivo.

O método OnPrepareBackup sempre será executado quando o objeto IBackupRestore foi selecionado para backup. Se ele retornar false, nem o OnBackup como os métodos de OnBackupComplete serão executado.

Examples

O exemplo a seguir mostra uma implementação mínima de OnPrepareBackup, que geralmente é tudo o que é necessário

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

Ver também

Referência

IBackupRestore interface

IBackupRestore members

Microsoft.SharePoint.Administration.Backup namespace

Compartilhar via