Метод IBackupRestore.OnPrepareBackup

Статья
05/13/2015

Предоставляет обработку перед резервным копированием подготовки.

Пространство имен: 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() используется для установки параметров для объекта SPBackupInformation (args), чтобы их можно использовать с более поздней версии обработчиков событий, особенно OnPreRestore и OnRestore.

Некоторые примеры того, что может выполняться в OnPrepareBackup:

Задавайте параметр SPNameargs со значением свойства Name .
Если компонент контента, представленного объектом IBackupRestore какой-либо базы данных, OnPrepareBackup можно использовать для указания параметров сведения, необходимые для подключения с помощью приложения базы данных.
Если компонент контента, представленного объектом IBackupRestore дублируются на каждом сервере переднего плана, OnPrepareBackup можно использовать для указания сервера, который будет источник операции резервного копирования. Задайте для параметра SPServer URL-адрес выбранного сервера, как показано в следующем примере:
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL");
```
```
args.SetParameter(SPBackupRestoreObject.SPServer, "some_URL")
```
Если реализация OnPrepareBackup принимает значительную часть общего времени операции резервного копирования, необходимо задайте args.CurrentProgess() соответствующее значение.

Важно!

Не остановить или приостановить службы или веб-приложения в метод 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

Поделиться через