SPBackupRestoreInformation.SetParameter method

Adiciona o par chave-valor especificado para um armazenamento interno de parâmetros.

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

Syntax

'Declaração
Public Sub SetParameter ( _
    key As String, _
    value As Object _
)
'Uso
Dim instance As SPBackupRestoreInformation
Dim key As String
Dim value As Object

instance.SetParameter(key, value)

public void SetParameter(
    string key,
    Object value
)

Parâmetros

• key
  Type: System.String

  O nome do parâmetro, que serve como uma chave de pesquisa.

• value
  Type: System.Object

  O objeto atribuído ao parâmetro como seu valor. Se este objeto for do tipo SPBackupRestoreParameter, que é o que será salvo. Caso contrário, ele será convertido em uma seqüência de caracteres através do método de ToString() do objeto e salvará essa cadeia de caracteres.

Exceptions

Comentários

Se a chave de parâmetro é "SPDescription", "SPTypeName" ou "SPObjectGroup", a exceção não é lançada, mesmo que o objeto SPBackupRestoreInformation é somente leitura.

Examples

O exemplo a seguir mostra como usar o método SetParameter em uma implementação do método 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

Ver também

Referência

SPBackupRestoreInformation class

SPBackupRestoreInformation members

Microsoft.SharePoint.Administration.Backup namespace