SPJobDefinition.OnAbort Method

Called when a user cancels the operation.

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

Syntax

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

returnValue = instance.OnAbort(sender, _
    info)

public virtual bool OnAbort(
    Object sender,
    SPBackupRestoreInformation info
)

Parameters

• sender
  Type: System.Object

  The source of the event.

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

  The backup information for this object.

Return Value

Type: System.Boolean
true when the cancellation is complete.

Implements

IBackupRestore.OnAbort(Object, SPBackupRestoreInformation)

Remarks

This method should be called only by the backup/restore process.

See Also

Reference

SPJobDefinition Class

SPJobDefinition Members

Microsoft.SharePoint.Administration Namespace