IBackupRestore.OnPrepareBackup method

提供處理備份前的準備。

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

Syntax

'宣告
Function OnPrepareBackup ( _
    sender As Object, _
    args As SPBackupInformation _
) As Boolean
'用途
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
)

參數

• sender
  Type: System.Object

  呼叫OnPrepareBackup物件。

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

  SPBackupInformation物件包含關於作業的資料。

傳回值

Type: System.Boolean
true如果成功 ；否則，請false。

備註

OnPrepareBackup主要用途是使用**SetParameter()**方法可設定的SPBackupInformation物件 (args) 參數，以便他們可以使用更新事件處理常式，尤其是OnPreRestore和OnRestore。

OnPrepareBackup中，您可以選擇的一些範例：

• 一律將SPName參數的argsName屬性的值。

• 如果資料庫某種內容IBackupRestore物件所代表的元件， OnPrepareBackup可用來指定要連線之資料庫應用程式與所需的設定資訊。

• 如果IBackupRestore物件所代表的內容元件會在每個前端伺服器上有重複， OnPrepareBackup可用來指定要將備份作業的來源的伺服器。將SPServer參數使用所選擇的伺服器的 URL 如本範例所示：

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

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

• 如果您的OnPrepareBackup實作需備份作業的總時間重要部分，設定args。**CurrentProgess()**適當的值。

重要

請勿停止或暫停服務或OnPrepareBackup方法中的 Web 應用程式。請參閱 ＜ OnBackup(Object, SPBackupInformation)的原因。

IBackupRestore物件有已選取 [備份時，一律會執行OnPrepareBackup方法。如果它會傳回false，將會執行OnBackup皆OnBackupComplete方法。

Examples

下列範例會顯示OnPrepareBackup，最少實作這通常是所有所需

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

請參閱

參照

IBackupRestore interface

IBackupRestore members

Microsoft.SharePoint.Administration.Backup namespace