TransactionRoll |
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.
Be aware that the returned status does not have to be necessarily the same like the status returned by GetStatus even 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. (See FailureHandlingOptions for more details.)
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. |
// 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)); }