Share via


SPBackupRestoreObject.Information property

Gets an object that holds information about a backup up or restore operation that is currently underway for the component represented by the SPBackupRestoreObject.

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

Syntax

'Declaration
Public ReadOnly Property Information As SPBackupRestoreInformation
    Get
'Usage
Dim instance As SPBackupRestoreObject
Dim value As SPBackupRestoreInformation

value = instance.Information
public SPBackupRestoreInformation Information { get; }

Property value

Type: Microsoft.SharePoint.Administration.Backup.SPBackupRestoreInformation
A SPBackupRestoreInformation (always either an SPBackupInformation or an SPRestoreInformation) that holds information that is needed by an operation's SPBackupRestoreConsoleObject to backup or restore the component.

Examples

The following example shows how to use the Information property in an implementation of the AddBackupObjects method.

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

See also

Reference

SPBackupRestoreObject class

SPBackupRestoreObject members

Microsoft.SharePoint.Administration.Backup namespace