Метод SPBackupRestoreInformation.SetParameter

Статья
05/13/2015

Добавляет указанный пары ключ значение внутреннего хранилища параметров.

Пространство имен: Microsoft.SharePoint.Administration.Backup
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Sub SetParameter ( _
    key As String, _
    value As Object _
)
'Применение
Dim instance As SPBackupRestoreInformation
Dim key As String
Dim value As Object

instance.SetParameter(key, value)

public void SetParameter(
    string key,
    Object value
)

Параметры

key
Тип: System.String

Имя параметра, который выступает в качестве ключа поиска.

value
Тип: System.Object

Объект, назначенный для параметра как его значение. Если этот объект имеет тип SPBackupRestoreParameter, затем это что будут сохранены. Если нет, он будет преобразован в строку с помощью метода ToString() объекта и этой строки будут записаны.

Исключения

Исключение	Условие
SPException	Объект SPBackupRestoreInformation доступен только для чтения. (Примечания Дополнительные сведения см.)

Замечания

Если ключ параметра «SPDescription», «SPTypeName» или «SPObjectGroup», не исключение, даже если объект SPBackupRestoreInformation только для чтения.

Примеры

Следующем примере показано, как использовать метод SetParameter в реализации метода AddBackupObjects .

public void AddBackupObjects(SPBackupRestoreObject parent)
{
    if (parent == null)
    {
        throw new ArgumentNullException("parent");
    }

    SPBackupRestoreObject self = parent.AddChild(this);
    self.Information.SetParameter(SPBackupRestoreObject.SPTypeName, this.GetType());
    self.Information.SetParameter(SPBackupRestoreObject.SPDescription, "Description of custom content component");

    foreach (ChildContent child in ChildContentCollection)
    {
        IBackupRestore childIBR = child as IBackupRestore;
        childIBR.AddBackupObjects(self);
    }
}

Public Sub AddBackupObjects(ByVal parent As SPBackupRestoreObject)
    If parent Is Nothing Then
        Throw New ArgumentNullException("parent")
    End If

    Dim self As SPBackupRestoreObject = parent.AddChild(Me)
    self.Information.SetParameter(SPBackupRestoreObject.SPTypeName, Me.GetType())
    self.Information.SetParameter(SPBackupRestoreObject.SPDescription, "Description of custom content component")

     For Each child As ChildContent In ChildContentCollection
        Dim childIBR As IBackupRestore = TryCast(child, IBackupRestore)
        childIBR.AddBackupObjects(self)
    Next child
End Sub

См. также

Справочные материалы

SPBackupRestoreInformation класс

Элементы SPBackupRestoreInformation

Пространство имен Microsoft.SharePoint.Administration.Backup

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