SPBackupRestoreInformation.SetParameter - Méthode

Article
10/14/2015

Ajoute la paire clé / valeur spécifiée dans un magasin interne de paramètres.

Espace de noms : Microsoft.SharePoint.Administration.Backup
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Sub SetParameter ( _
    key As String, _
    value As Object _
)
'Utilisation
Dim instance As SPBackupRestoreInformation
Dim key As String
Dim value As Object

instance.SetParameter(key, value)

public void SetParameter(
    string key,
    Object value
)

Paramètres

key
Type : System.String

Le nom du paramètre, qui sert de clé de recherche.

value
Type : System.Object

L'objet assigné au paramètre comme étant sa valeur. Si cet objet est de type SPBackupRestoreParameter, qui est ce qui sera enregistré. Si ce n'est pas le cas, il sera converti en une chaîne via la méthode ToString() de l'objet, puis cette chaîne sera enregistrée.

Exceptions

Exception	Condition
SPException	L'objet SPBackupRestoreInformation est en lecture seule. (Pour plus d'informations, voir Remarques.)

Remarques

Si la clé de paramètre est « SPDescription », « SPTypeName », soit « SPObjectGroup », l'exception n'est levée que même si l'objet SPBackupRestoreInformation est en lecture seule.

Exemples

L'exemple suivant montre comment utiliser la méthode SetParameter dans une implémentation de la méthode 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

Voir aussi

Référence

SPBackupRestoreInformation classe

SPBackupRestoreInformation - Membres

Microsoft.SharePoint.Administration.Backup - Espace de noms

Partager via