SPFarm.OnAbort Method

Raises the Abort (backup) event.

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

Syntax

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

returnValue = instance.OnAbort(sender, _
    info)

public bool OnAbort(
    Object sender,
    SPBackupRestoreInformation info
)

Parameters

• sender
  Type: System.Object

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

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

  An SPBackupRestoreInformation object that contains data about the event.

Return Value

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

Implements

IBackupRestore.OnAbort(Object, SPBackupRestoreInformation)

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