All docs
V20.2
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

AuditTrailService.BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) Method

Starts auditing changes made to the object within the specified session.

Namespace: DevExpress.Persistent.AuditTrail

Assembly: DevExpress.Persistent.BaseImpl.v20.2.dll

Declaration

public ObjectAuditProcessor BeginSessionAudit(
    Session session,
    AuditTrailStrategy strategy,
    ObjectAuditingMode auditingMode
)
Public Function BeginSessionAudit(
    session As Session,
    strategy As AuditTrailStrategy,
    auditingMode As ObjectAuditingMode
) As ObjectAuditProcessor

Parameters

Name Type Description
session Session

The Session to be audited.

strategy DevExpress.Persistent.AuditTrail.AuditTrailStrategy

The AuditTrailStrategy value.

auditingMode DevExpress.Persistent.AuditTrail.ObjectAuditingMode

The ObjectAuditingMode value that is the object auditing mode. The default value is Full.

Returns

Type Description
DevExpress.Persistent.AuditTrail.ObjectAuditProcessor

A processor that the Audit Trail Module uses for the specified auditingMode.

Remarks

NOTE

If you want to disable and enable the Audit Trail Module for a particular scenario, use solutions from the following help topic: Disable the Audit Trail Module.

The following code demonstrates how to call this method:

using DevExpress.ExpressApp;
using DevExpress.Persistent.AuditTrail;
using DevExpress.Xpo;
// ...
public partial class MyController : ViewController {
    protected override void OnActivated() {
        base.OnActivated();
        Session session = ((XPObjectSpace)ObjectSpace).Session;
        AuditTrailService.Instance.EndSessionAudit(session);
        // ...
        AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Lightweight);
    }
    // ...
}
See Also