SPSolution.IBackupRestore.OnPrepareBackup Method

The event that is called when the system is preparing a backup operation.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Private Function OnPrepareBackup ( _
    sender As Object, _
    info As SPBackupInformation _
) As Boolean Implements IBackupRestore.OnPrepareBackup
'Usage
Dim instance As SPSolution
Dim sender As Object
Dim info As SPBackupInformation
Dim returnValue As Boolean

returnValue = CType(instance, IBackupRestore).OnPrepareBackup(sender, _
    info)

boolIBackupRestore.OnPrepareBackup(
    Object sender,
    SPBackupInformation info
)

Parameters

• sender
  Type: System.Object

  The object that is calling this event.

• info
  Type: Microsoft.SharePoint.Administration.Backup.SPBackupInformation

  The backup information for the solution.

Return Value

Type: System.Boolean
Returns true if the backup is prepared successfully; otherwise, false.

Implements

IBackupRestore.OnPrepareBackup(Object, SPBackupInformation)

Remarks

This function should not be called by anything except the backup and restore process.

See Also

Reference

SPSolution Class

SPSolution Members

Microsoft.SharePoint.Administration Namespace