SPBackupRestoreInformation.SetParameter-Methode

Artikel
05/06/2015

Der Parameter einen internen Datenspeicher hinzugefügt angegebenen Schlüssel-Wert-Paar.

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

Syntax

'Declaration
Public Sub SetParameter ( _
    key As String, _
    value As Object _
)
'Usage
Dim instance As SPBackupRestoreInformation
Dim key As String
Dim value As Object

instance.SetParameter(key, value)

public void SetParameter(
    string key,
    Object value
)

Parameter

key
Typ: System.String

Der Parametername, der als ein Schlüssel zum Nachschlagen dient.

value
Typ: System.Object

Das Objekt an den Parameter als Wert zugewiesen. Wenn dieses Objekt vom Typ SPBackupRestoreParameterist, handelt es sich was gespeichert werden. Wenn dies nicht der Fall ist, wird in eine Zeichenfolge über das Objekt ToString() -Methode konvertiert, und diese Zeichenfolge wird gespeichert.

Ausnahmen

Ausnahme	Bedingung
SPException	Das SPBackupRestoreInformation -Objekt ist schreibgeschützt. (Weitere Informationen finden Sie unter "Hinweise".)

Hinweise

Wenn der Parameterschlüssel "SPDescription", "SPTypeName" oder "SPObjectGroup" ist, wird die Ausnahme nicht ausgelöst, selbst wenn das Objekt SPBackupRestoreInformation schreibgeschützt ist.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie die SetParameter -Methode in einer Implementierung der AddBackupObjects -Methode verwenden.

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

Siehe auch

Referenz

SPBackupRestoreInformation Klasse

SPBackupRestoreInformation-Member

Microsoft.SharePoint.Administration.Backup-Namespace

Freigeben über