IBackupRestore.OnAbort Method

Assists in a graceful termination when a user cancels a backup or restore operation.

Namespace:  Microsoft.SharePoint.Administration.Backup
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Function OnAbort ( _
    sender As Object, _
    args As SPBackupRestoreInformation _
) As Boolean
'Usage
Dim instance As IBackupRestore
Dim sender As Object
Dim args As SPBackupRestoreInformation
Dim returnValue As Boolean

returnValue = instance.OnAbort(sender, _
    args)

bool OnAbort(
    Object sender,
    SPBackupRestoreInformation args
)

Parameters

• sender
  Type: System.Object

  The object that calls OnAbort.

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

  An SPBackupRestoreInformation object that contains data about the operation.

Return Value

Type: System.Boolean
true in all cases.

Remarks

An implementation of OnAbort should always return true. In most cases it should do nothing more. If, however, your backup or restore logic called another application, then your logic for canceling an operation would have to pass a cancel signal to the other application. For example, OnAbort can be used to close a connection to a database.

See Also

Reference

IBackupRestore Interface

IBackupRestore Members

Microsoft.SharePoint.Administration.Backup Namespace