Share via


SPBackupRestoreHistoryObject class

Represents a single current or past backup or restore operation.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Administration.Backup.SPBackupRestoreHistoryObject

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public NotInheritable Class SPBackupRestoreHistoryObject
'Usage
Dim instance As SPBackupRestoreHistoryObject
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public sealed class SPBackupRestoreHistoryObject

Remarks

An object of this class is created as soon as an operation begins. If the operation is cancelled, the history object remains in the history list (represented by SPBackupRestoreHistoryList) as an unfinished operation.

This class has no public constructor. Get a reference to a SPBackupRestoreHistoryObject object by using the Item property of SPBackupRestoreHistoryList.

Objects of this class persist as <SPHistoryObject> elements in the file spbrtoc.xml in the root of the backup location.

Examples

The following is an example of an <SPHistoryObject> element that records a backup of a SharePoint Foundation content database.

<SPHistoryObject>
    <SPId>b3aded39-25c8-48ba-b68e-ac4624536dba</SPId>
    <SPRestoreId>1c8fd1e6-cc2d-4500-9316-3b967934ddbd</SPRestoreId>
    <SPRequestedBy>FABRIKAM\bob</SPRequestedBy>
    <SPBackupMethod>Full</SPBackupMethod>
    <SPRestoreMethod>Overwrite</SPRestoreMethod>
    <SPStartTime>10/08/2007 20:20:13</SPStartTime>
    <SPFinishTime>10/08/2007 20:20:29</SPFinishTime>
    <SPIsBackup>False</SPIsBackup>
    <SPBackupDirectory>\\server01\WSSBackups\spbr0000\</SPBackupDirectory>
    <SPDirectoryName />
    <SPTopComponent>Farm\Windows SharePoint Services Web Application\SharePoint - 42712\WSS_Content_3cfae446821e442a8300185e58423876</SPTopComponent>
    <SPTopComponentId>88c72a5d-08c9-4ee9-9f6a-3cfc3ab7d359</SPTopComponentId>
    <SPWarningCount>0</SPWarningCount>
    <SPErrorCount>0</SPErrorCount>
</SPHistoryObject>

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

SPBackupRestoreHistoryObject members

Microsoft.SharePoint.Administration.Backup namespace