Namespace: Autodesk.Revit.DB Class: Transaction

Transaction.RollBack(FailureHandlingOptions)

Method

Description:
Rolls back all changes made to the model during the transaction.

Remarks:
By rolling back a transaction, all changes made to the model are discarded. RollBack may only be called for a transaction that has been started. (Use the GetStatus() method to check the current state.) Be aware that rolling back may be delayed (as a result of failure handling.) Callers should always check the returned status to test whether a transaction was rolled back successfully. Only after rolling back is fully completed, the transaction may be started again.

Syntax

public TransactionStatus RollBack(
	FailureHandlingOptions options
)

Public Function RollBack ( 
	options As FailureHandlingOptions
) As TransactionStatus

public:
TransactionStatus RollBack(
	FailureHandlingOptions^ options
)

member RollBack : 
        options : FailureHandlingOptions -> TransactionStatus

Examples

// All and any transaction should be enclosed in a 'using'
// block or guarded within a try-catch-finally blocks
// to guarantee that a transaction does not out-live its scope.
using (Transaction transaction = new Transaction(document))
{
   // Must start the transaction first to be able to modify a document
   transaction.Start("Creating Grid");

   // We create a line and use it as an argument to create a grid
   Line gridLine = Line.CreateBound(new XYZ(0, 0, elevation), new XYZ(20, 0, elevation));

   if ((null != gridLine) && (null != Grid.Create(document, gridLine)))
   {
      if (TransactionStatus.Committed == transaction.Commit())
      {
         return true;
      }
   }

   // We could not create the grid, so we roll the transaction back.

   // To demonstrate one particular property of failure handling options,
   // we can set clearing of accumulated warnings (if any) for this
   // transaction which is about to get rolled back anyway.
   // Clearing warnings is rarely desirable, but sometimes it is convenient.
   FailureHandlingOptions options = transaction.GetFailureHandlingOptions();

   transaction.RollBack(options.SetClearAfterRollback(true));
}

' All and any transaction should be enclosed in a 'using'
' block or guarded within a try-catch-finally blocks
' to guarantee that a transaction does not out-live its scope.
Using transaction As New Transaction(document)
    ' Must start the transaction first to be able to modify a document
    transaction.Start("Creating Grid")

    ' We create a line and use it as an argument to create a grid
    Dim gridLine As Line = Line.CreateBound(New XYZ(0, 0, elevation), New XYZ(20, 0, elevation))

If (gridLine IsNot Nothing) AndAlso (Grid.Create(document, gridLine) IsNot Nothing) Then
   If TransactionStatus.Committed = transaction.Commit() Then
      Return True
   End If
End If

    ' We could not create the grid, so we roll the transaction back.

    ' To demonstrate one particular property of failure handling options,
    ' we can set clearing of accumulated warnings (if any) for this
    ' transaction which is about to get rolled back anyway.
    ' Clearing warnings is rarely desirable, but sometimes it is convenient.
    Dim options As FailureHandlingOptions = transaction.GetFailureHandlingOptions()

    transaction.RollBack(options.SetClearAfterRollback(True))
End Using

Parameters

Parameter	Type	Description
options	FailureHandlingOptions	A set of <a href="c03bb2e5-f679-bf24-4e87-08b3c3a08385.htm">options</a> to be used for handling eventual failures during this call. <p>The options are only used temporarily during this rolling back process. After the transaction is finished, the options will be reset to their default values.</p>

Return Value

Type	Description
TransactionStatus	If finished successfully, this method returns TransactionStatus.RolledBack. Be aware that the returned status does not have to be necessarily the same like the status returned byGetStatuseven when the method is called immediately after rolling back the transaction. Such difference may happen due to actions made by a transaction finalizer, if there was one set. (SeeFailureHandlingOptionsfor more details.)

Type

Description

TransactionStatus

If finished successfully, this method returns TransactionStatus.RolledBack. Be aware that the returned status does not have to be necessarily the same like the status returned byGetStatuseven when the method is called immediately after rolling back the transaction. Such difference may happen due to actions made by a transaction finalizer, if there was one set. (SeeFailureHandlingOptionsfor more details.)

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was null
InvalidOperationException	The current status of the transaction is not 'Started'. Transaction must be started before calling Commit or Rollback. -or- The transaction's document is currently in failure mode. No transaction operations are permitted until failure handling is finished.