Share via


SPRestoreInformation members

Provides information about a restore operation that is currently underway or just completed.

The SPRestoreInformation type exposes the following members.

Properties

  Name Description
Public property BackupMethod Gets the backup method of the job. (Inherited from SPBackupRestoreInformation.)
Public property BackupRestoreRoot Gets the highest level content component in the backup object. (Inherited from SPBackupRestoreInformation.)
Public property CanBeRenamed Gets a value that indicates whether the component (farm, Web service, Web application, or content database) that is being restored can be renamed.
Public property Children Gets the immediate children of the backup object. (Inherited from SPBackupRestoreInformation.)
Public property CurrentProgress Gets or sets, as a percentage of the whole job, the degree to which the backup or restore operation is complete. (Inherited from SPBackupRestoreInformation.)
Public property FailureMessage Gets or sets a message explaining why the operation has failed. (Inherited from SPBackupRestoreInformation.)
Public property HasMoreRestore Gets a value that indicates whether the restore operation has more to restore after it has completed work on the current component it is restoring.
Public property Initializing Gets a value that indicates whether the restore operation is initializing.
Public property IsBackup Gets a value that specifies whether the operation is a backup or a restore. (Inherited from SPBackupRestoreInformation.)
Public property IsFailure Gets a value that indicates whether the operation has failed. (Inherited from SPBackupRestoreInformation.)
Public property IsRestart Obsolete. Do not use. (Inherited from SPBackupRestoreInformation.)
Public property LastUpdate Gets a value that specifies the last time CurrentProgress was updated. (Inherited from SPBackupRestoreInformation.)
Public property Location Gets the Universal Naming Convention (UNC) path where the backup is stored. (Inherited from SPBackupRestoreInformation.)
Public property NewName Gets the name that is given to the component (farm, Web service, Web application, or content database) that is being restored if it is renamed.
Public property ObjectGroup Gets or sets a name for a group of objects that can be backed up so that they do not have to be individually listed in a UI as selectable items for a backup or restore operation. (Inherited from SPBackupRestoreInformation.)
Public property Parameters Gets a set of parameters for backup or restore operations. (Inherited from SPBackupRestoreInformation.)
Public property Parent Gets the parent backup object of the current operation's backup object. (Inherited from SPBackupRestoreInformation.)
Public property ParentRestore Gets an IBackupRestore object that represents the parent component of the component that is being restored.
Public property ParentRestoreInformation Gets the parent SPRestoreInformation of this SPRestoreInformation.
Public property RestoreMethod Gets the restore method of the operation.
Public property Self Gets or sets the backup object that is the result of the current operation (if the operation is a backup), or is the source of the current operation (if the operation is a restore). (Inherited from SPBackupRestoreInformation.)
Public property UpdateProgress Gets a value that specifies at what points the operation should report its progress. (Inherited from SPBackupRestoreInformation.)
Public property WasDifferentialBackupRequested Gets a value that indicates whether the source backup of a restore operation was a differential backup.

Top

Methods

  Name Description
Public method ChangePersistedObjectParentId Sets the parent ID of the SPPersistedObject associated with the SPRestoreInformation object.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GenerateFileMapping Generates a unique name for the backup file that contains the specified source file. (Inherited from SPBackupRestoreInformation.)
Public method GetHashCode (Inherited from Object.)
Public method GetParameter Returns the value assigned to the specified key in an internal store of key-value pairs. (Inherited from SPBackupRestoreInformation.)
Public method GetParameterObject Get the value for the parameter with the specified name. (Inherited from SPBackupRestoreInformation.)
Public method GetType (Inherited from Object.)
Public method Log(SqlCommand) Writes the specified SqlCommand as a string to the backup or restore log file. (Inherited from SPBackupRestoreInformation.)
Public method Log(SPBackupRestoreLogSeverity, String) Writes an error, warning, or informational message to the administration log file. (Inherited from SPBackupRestoreInformation.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeSPPersistedObjectState Merges the configuration settings of the component that is the source of a restoration (Self) into the configuration settings of the target component.
Public method Rename Renames, with NewName, the component that is being restored.
Public method ReverseFileMapping Gets the name of the backup file that contains the specified file. (Inherited from SPBackupRestoreInformation.)
Public method SetInputValue Sets the specified parameter to the specified value, which should be input from a user. (Inherited from SPBackupRestoreInformation.)
Public method SetParameter Adds the specified key-value pair to an internal store of parameters. (Inherited from SPBackupRestoreInformation.)
Public method SetUserNamePassword Assigns the specified password to the specified user. (Inherited from SPBackupRestoreInformation.)
Public method ToString (Inherited from Object.)

Top

See also

Reference

SPRestoreInformation class

Microsoft.SharePoint.Administration.Backup namespace