SPWebApplication.OnPrepareBackup Method

Raises the PreBackup 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 SPWebApplication
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

  The SPWebApplication 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 SharePoint Foundation catastrophic backup and restore infrastructure code.

See Also

Reference

SPWebApplication Class

SPWebApplication Members

Microsoft.SharePoint.Administration Namespace