Partager via


SPBackupRestoreObject.SPDescription - Champ

Définit un String qui peut être utilisé pour définir ou obtenir la valeur du paramètre de description de l'objet retourné par la propriété Information .

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

Syntaxe

'Déclaration
Public Const SPDescription As String
'Utilisation
Dim value As String

value = SPBackupRestoreObject.SPDescription
public const string SPDescription

Remarques

Pour plus d'informations sur l'utilisation de cette constante, consultez GetParameter et SetParameter.

Exemples

L'exemple suivant montre comment utiliser le champ SPDescription 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

SPBackupRestoreObject classe

SPBackupRestoreObject - Membres

Microsoft.SharePoint.Administration.Backup - Espace de noms