Session.CommitTransactionAsync(CancellationToken) Method

Asynchronously commits object changes made within a transaction, completes the transaction, and notifies upon completion.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public virtual Task CommitTransactionAsync(
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Overridable Function CommitTransactionAsync(
    cancellationToken As CancellationToken = Nothing
) As Task

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task	A Task that commits object changes made within a transaction and completes the transaction.

Remarks

To start a transaction, use the Session.BeginTransaction method. To commit all data modifications made since the start of the transaction and complete the transaction, call the CommitTransactionAsync or Session.CommitTransaction method. To discard these modifications, call the Session.RollbackTransaction method.

To determine if a transaction is in progress, use the Session.InTransaction property.

After the CommitTransactionAsync method is called, the Session.BeforeCommitTransaction event is raised.

Note

In a Nested Units of Work, calling the CommitTransactionAsync method throws the System.NotSupportedException, since changes within these Units should be saved using only the main thread.