Freigeben über


IBackupRestore.OnPrepareBackup-Methode

Vorbereitung Verarbeitung vor der Sicherung enthält.

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

Syntax

'Declaration
Function OnPrepareBackup ( _
    sender As Object, _
    args As SPBackupInformation _
) As Boolean
'Usage
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
)

Parameter

  • sender
    Typ: System.Object

    Das Objekt, das OnPrepareBackupaufruft.

Rückgabewert

Typ: System.Boolean
true bei erfolgreicher; andernfalls false.

Hinweise

Eine größere OnPrepareBackup dient die SetParameter() -Methode verwenden, um die Parameter des SPBackupInformation -Objekts (args) festlegen, damit sie später Ereignishandler, insbesondere OnPreRestore und OnRestoreverwendet werden können.

Einige Beispiele für Aktionen in OnPrepareBackupdurchgeführt werden können:

  • Den Parameter SPName des args mit dem Wert der Eigenschaft Name immer festgelegt.

  • Wenn der durch das IBackupRestore -Objekt dargestellten Inhaltskomponente verschiedenste der Datenbank ist, kann OnPrepareBackup Einstellungsinformationen zum Verbinden mit der Datenbankanwendung erforderliche angeben verwendet werden.

  • Wenn der durch das IBackupRestore -Objekt dargestellten Inhaltskomponente doppelt auf jedem Front-End-Server vorhanden ist, kann OnPrepareBackup verwendet werden, mit welchem Server, die die Quelle des Sicherungsvorgangs werden. Legen Sie den SPServer -Parameter mit der URL des gewünschten Servers ein, wie im folgenden Beispiel dargestellt:

    args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL");
    
    args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL")
    
  • Wenn die Implementierung von OnPrepareBackup einen Großteil der Gesamtzeit für den Sicherungsvorgang akzeptiert, legen Sie args.CurrentProgess() einen geeigneten Wert.

Wichtig

Beenden Sie oder unterbrechen Sie Diensts oder einer Webanwendung in der OnPrepareBackup -Methode nicht. Finden Sie unter OnBackup(Object, SPBackupInformation) warum.

Die OnPrepareBackup -Methode wird immer ausgeführt, wenn das Objekt IBackupRestore für die Sicherung ausgewählt wurde. Wenn falsezurückgegeben wird, werden weder die OnBackup noch die OnBackupComplete Methoden ausgeführt.

Beispiele

Das folgende Beispiel zeigt eine minimale Implementierung von OnPrepareBackup, mit dem ist häufig erforderlich ist

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

Siehe auch

Referenz

IBackupRestore Schnittstelle

IBackupRestore-Member

Microsoft.SharePoint.Administration.Backup-Namespace