IBackupRestore.OnPrepareBackup - Méthode

Fournit la préparation de traitement avant une sauvegarde.

Espace de noms :  Microsoft.SharePoint.Administration.Backup
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Function OnPrepareBackup ( _
    sender As Object, _
    args As SPBackupInformation _
) As Boolean
'Utilisation
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
)

Paramètres

• sender
  Type : System.Object

  L'objet qui appelle OnPrepareBackup.

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

  Objet SPBackupInformation qui contient les données relatives à l'opération.

Valeur renvoyée

Type : System.Boolean
true en cas de réussite ; dans le cas contraire, false.

Remarques

Un objectif majeur de OnPrepareBackup consiste à utiliser la méthode SetParameter() pour définir les paramètres de l'objet SPBackupInformation (args) afin qu'ils peuvent être utilisés par une version ultérieure gestionnaires d'événements, notamment OnPreRestore et OnRestore.

Voici quelques exemples de ce qui peut être fait dans OnPrepareBackup:

• Toujours la valeur du paramètre SPName de args avec la valeur de la propriété Name .

• Si le composant de contenu représenté par l'objet IBackupRestore est un type de base de données, OnPrepareBackup peut être utilisé pour spécifier des informations sur les paramètres requises pour se connecter à l'application de base de données.

• Si le composant de contenu représenté par l'objet IBackupRestore est dupliqué sur chaque serveur frontal, OnPrepareBackup peut être utilisé pour spécifier le serveur qui sera la source de l'opération de sauvegarde. Définissez le paramètre SPServer avec l'URL du serveur choisi comme indiqué dans cet exemple :

  args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL");
  

  args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL")
  

• Si votre implémentation de OnPrepareBackup prend une part importante du temps total de l'opération de sauvegarde, la valeur args.CurrentProgess() à une valeur appropriée.

La méthode OnPrepareBackup est toujours exécutés lorsque l'objet IBackupRestore a été sélectionné pour la sauvegarde. Si elle retourne false, le OnBackup , ni les méthodes OnBackupComplete seront exécute.

Exemples

L'exemple suivant montre une implémentation minimale de OnPrepareBackup, qui est souvent tout ce qui est nécessaire

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

Voir aussi

Référence

IBackupRestore interface

IBackupRestore - Membres

Microsoft.SharePoint.Administration.Backup - Espace de noms