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 | |
|---|---|---|
.gif "Public property") |
BackupMethod | Gets the backup method of the job. (Inherited from SPBackupRestoreInformation.) |
|
BackupRestoreRoot | Gets the highest level content component in the backup object. (Inherited from SPBackupRestoreInformation.) |
|
CanBeRenamed | Gets a value that indicates whether the component (farm, Web service, Web application, or content database) that is being restored can be renamed. |
|
Children | Gets the immediate children of the backup object. (Inherited from SPBackupRestoreInformation.) |
|
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.) |
|
FailureMessage | Gets or sets a message explaining why the operation has failed. (Inherited from SPBackupRestoreInformation.) |
|
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. |
|
Initializing | Gets a value that indicates whether the restore operation is initializing. |
|
IsBackup | Gets a value that specifies whether the operation is a backup or a restore. (Inherited from SPBackupRestoreInformation.) |
|
IsFailure | Gets a value that indicates whether the operation has failed. (Inherited from SPBackupRestoreInformation.) |
|
IsRestart | Obsolete. Do not use. (Inherited from SPBackupRestoreInformation.) |
|
LastUpdate | Gets a value that specifies the last time CurrentProgress was updated. (Inherited from SPBackupRestoreInformation.) |
|
Location | Gets the Universal Naming Convention (UNC) path where the backup is stored. (Inherited from SPBackupRestoreInformation.) |
|
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. |
|
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.) |
|
Parameters | Gets a set of parameters for backup or restore operations. (Inherited from SPBackupRestoreInformation.) |
|
Parent | Gets the parent backup object of the current operation's backup object. (Inherited from SPBackupRestoreInformation.) |
|
ParentRestore | Gets an IBackupRestore object that represents the parent component of the component that is being restored. |
|
ParentRestoreInformation | Gets the parent SPRestoreInformation of this SPRestoreInformation. |
|
RestoreMethod | Gets the restore method of the operation. |
|
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.) |
|
UpdateProgress | Gets a value that specifies at what points the operation should report its progress. (Inherited from SPBackupRestoreInformation.) |
|
WasDifferentialBackupRequested | Gets a value that indicates whether the source backup of a restore operation was a differential backup. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ChangePersistedObjectParentId | Sets the parent ID of the SPPersistedObject associated with the SPRestoreInformation object. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GenerateFileMapping | Generates a unique name for the backup file that contains the specified source file. (Inherited from SPBackupRestoreInformation.) |
|
GetHashCode | (Inherited from Object.) |
|
GetParameter | Returns the value assigned to the specified key in an internal store of key-value pairs. (Inherited from SPBackupRestoreInformation.) |
|
GetParameterObject | Get the value for the parameter with the specified name. (Inherited from SPBackupRestoreInformation.) |
|
GetType | (Inherited from Object.) |
|
Log(SqlCommand) | Writes the specified SqlCommand as a string to the backup or restore log file. (Inherited from SPBackupRestoreInformation.) |
|
Log(SPBackupRestoreLogSeverity, String) | Writes an error, warning, or informational message to the administration log file. (Inherited from SPBackupRestoreInformation.) |
|
MemberwiseClone | (Inherited from Object.) |
|
MergeSPPersistedObjectState | Merges the configuration settings of the component that is the source of a restoration (Self) into the configuration settings of the target component. |
|
Rename | Renames, with NewName, the component that is being restored. |
|
ReverseFileMapping | Gets the name of the backup file that contains the specified file. (Inherited from SPBackupRestoreInformation.) |
|
SetInputValue | Sets the specified parameter to the specified value, which should be input from a user. (Inherited from SPBackupRestoreInformation.) |
|
SetParameter | Adds the specified key-value pair to an internal store of parameters. (Inherited from SPBackupRestoreInformation.) |
|
SetUserNamePassword | Assigns the specified password to the specified user. (Inherited from SPBackupRestoreInformation.) |
|
ToString | (Inherited from Object.) |
Top