SPBackupRestoreObject 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
	CanBackup	Gets or sets a value that indicates whether the component represented by the IBackupRestore property has been selected for backup.
	CanRestore	Gets or sets a value that indicates whether the component represented by the IBackupRestore property has been selected for restoration.
	Children	Gets a collection of objects that represent the child components of the component that the SPBackupRestoreObject object represents.
	CurrentPhase	Gets a value indicating the phase of the current operation.
	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.
	FullPath	Gets the full path, in the tree of components, of the component represented by the SPBackupRestoreObject.
	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.
	Id	Gets the ID of the SPBackupRestoreObject.
	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.
	IsFarmSelected	Gets a value that indicates whether the farm is selected.
	IsRoot	Gets a value that indicates whether the component that is represented by the SPBackupRestoreObject is the root of the tree of components.
	MustRename	Gets a value that indicates whether the component must be renamed when it is restored.
	Name	Gets the name of the SPBackupRestoreObject object.
	Parent	Gets the SPBackupRestoreObject that represents the parent component of the component represented by this SPBackupRestoreObject.

Top

Methods

	Name	Description
	AddChild(IBackupRestore)	Adds a child component to the component represented by this SPBackupRestoreObject.
	AddChild(SPBackupRestoreObject)	Adds a child component to the component represented by this SPBackupRestoreObject.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindObject	Returns the SPBackupRestoreObject with the specified ID.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	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.
	Rename(String, String, String)	Renames a component that is being restored to a different place on the farm from where it was backed up.
	Reparent	Moves the SPBackupRestoreObject object to a new parent SPBackupRestoreObject object.
	ToString	Returns the fully qualified name of the component represented by the IBackupRestore property. (Overrides Object.ToString().)

Top

Fields

	Name	Description
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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