IBackupRestore.OnPrepareBackup 方法

提供处理备份之前的准备工作。

命名空间：  Microsoft.SharePoint.Administration.Backup
程序集：  Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）

语法

声明
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
  类型：System.Object

  调用OnPrepareBackup的对象。

• args
  类型：Microsoft.SharePoint.Administration.Backup.SPBackupInformation

  SPBackupInformation对象，该对象包含有关该操作的数据。

返回值

类型：System.Boolean
true如果成功 ；否则为false。

备注

OnPrepareBackup的主要目的是使用**SetParameter()**方法来设置 （args） 的SPBackupInformation对象的参数，以便可供以后的事件处理程序，尤其是OnPreRestore和OnRestore。

在OnPrepareBackup可以做什么的一些示例：

• 始终设置Name属性的值与args的SPName参数。

• 如果IBackupRestore对象所表示的内容的组件是某种类型的数据库， OnPrepareBackup可用于指定连接与数据库应用程序所需的设置信息。

• 由IBackupRestore对象所表示的内容组件被复制到每台前端服务器上，如果OnPrepareBackup可用于指定哪台服务器将备份操作的源。将所选的服务器的 url SPServer参数的设置，如本示例所示：

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

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

• 如果您的OnPrepareBackup的实现采用大部分用于备份操作的总时间，设置args。为适当的值CurrentProgess() 。

重要信息
不要停止或暂停服务或 Web 应用程序中的OnPrepareBackup方法。请参阅OnBackup(Object, SPBackupInformation)中的原因。

OnPrepareBackup方法总是在运行时选择了进行备份的IBackupRestore对象。如果它返回false， OnBackup和OnBackupComplete方法都不会运行。

示例

下面的示例演示最小实现的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 接口

IBackupRestore 成员

Microsoft.SharePoint.Administration.Backup 命名空间