SPBackupRestoreObject Members

Include Protected Members
Include Inherited Members

Provides helper functions for backup and restore operations and acts as a container for an SPBackupRestoreInformation object and its correlated IBackupRestore object.

The SPBackupRestoreObject type exposes the following members.

Properties

  Name Description
Public property CanBackup Gets or sets a value that indicates whether the component represented by the IBackupRestore property has been selected for backup.
Public property CanRestore Gets or sets a value that indicates whether the component represented by the IBackupRestore property has been selected for restoration.
Public property Children Gets a collection of objects that represent the child components of the component that the SPBackupRestoreObject object represents.
Public property CurrentPhase Gets a value indicating the phase of the current operation.
Public property DisplayName Gets the new and old names of the SPBackupRestoreObject object when the operation is a restore to a new name; otherwise just returns the name.
Public property FullPath Gets the full path, in the tree of components, of the component represented by the SPBackupRestoreObject.
Public property IBackupRestore Gets an object that represents a component of a type that can, in principle, be backed up or restored, and provides information about the component that is relevant to processing a backup or restoration of the component.
Public property Id Gets the ID of the SPBackupRestoreObject.
Public property Information Gets an object that holds information about a backup up or restore operation that is currently underway for the component represented by the SPBackupRestoreObject.
Public property IsFarmSelected Gets a value that indicates whether the farm is selected.
Public property IsRoot Gets a value that indicates whether the component that is represented by the SPBackupRestoreObject is the root of the tree of components.
Public property MustRename Gets a value that indicates whether the component must be renamed when it is restored.
Public property Name Gets the name of the SPBackupRestoreObject object.
Public property Parent Gets the SPBackupRestoreObject that represents the parent component of the component represented by this SPBackupRestoreObject.

Top

Methods

  Name Description
Public method AddChild(IBackupRestore) Adds a child component to the component represented by this SPBackupRestoreObject.
Public method AddChild(SPBackupRestoreObject) Adds a child component to the component represented by this SPBackupRestoreObject.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindObject Returns the SPBackupRestoreObject with the specified ID.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Rename(String, String) Changes, during a restoration operation, the value of the specified parameter from what it was at the time of the backup to the specified new value.
Public method Rename(String, String, String) Renames a component that is being restored to a different place on the farm from where it was backed up.
Public method Reparent Moves the SPBackupRestoreObject object to a new parent SPBackupRestoreObject object.
Public method ToString Returns the fully qualified name of the component represented by the IBackupRestore property. (Overrides Object.ToString().)

Top

Fields

  Name Description
Public fieldStatic member SPDescription Defines a String that can be used to set or get the value of the description parameter in the object returned by the Information property.
Public fieldStatic member SPLocation Defines a String that can be used to set or get the value of the location parameter in the object returned by the Information property.
Public fieldStatic member SPName Defines a String that can be used to set or get the value of the name parameter in the object returned by the Information property.
Public fieldStatic member SPNewLocation Defines a String that can be used to set or get the value of the new location parameter in the object returned by the Information property.
Public fieldStatic member SPNewName Defines a String that can be used to set or get the value of the new name parameter in the object returned by the Information property.
Public fieldStatic member SPNewPassword Defines a String that can be used to set or get the value of the new user password parameter in the object returned by the Information property.
Public fieldStatic member SPNewServer Defines a String that can be used to set or get the value of the new server parameter in the object returned by the Information property.
Public fieldStatic member SPNewUserName Defines a String that can be used to set or get the value of the new user name parameter in the object returned by the Information property.
Public fieldStatic member SPServer Defines a String that can be used to set or get the value of the server parameter in the object returned by the Information property.
Public fieldStatic member SPTypeName Defines a String that can be used to set or get the value of the type name parameter in the object returned by the Information property.
Public fieldStatic member SPUserName Defines a String that can be used to set or get the value of the user name parameter in the object returned by the Information property.
Public fieldStatic member SPWebApplicationId Defines a String that can be used to set or get the value of the Web application ID parameter in the object returned by the Information property.

Top

See Also

Reference

SPBackupRestoreObject Class

Microsoft.SharePoint.Administration.Backup Namespace