SPFarm.OnPrepareBackup Method

Raises the PrepareBackup event.

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

Syntax

'Declaration
Public Function OnPrepareBackup ( _
    sender As Object, _
    info As SPBackupInformation _
) As Boolean
'Usage
Dim instance As SPFarm
Dim sender As Object
Dim info As SPBackupInformation
Dim returnValue As Boolean

returnValue = instance.OnPrepareBackup(sender, _
    info)

public bool OnPrepareBackup(
    Object sender,
    SPBackupInformation info
)

Parameters

• sender
  Type: System.Object

  An object that represents the server farm that is being backed up.

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

  An SPBackupInformation object that contains data about the event.

Return Value

Type: System.Boolean
true if successful; otherwise, false.

Implements

IBackupRestore.OnPrepareBackup(Object, SPBackupInformation)

Remarks

This method is only intended to be called from catastrophic backup and restore infrastructure code in SharePoint Foundation.

See Also

Reference

SPFarm Class

SPFarm Members

Microsoft.SharePoint.Administration Namespace