.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Session.FindObjectAsync<ClassType>(PersistentCriteriaEvaluationBehavior, CriteriaOperator, CancellationToken) Method

Asynchronously searches for the first object that matches the specified criteria. This object's type is designated by the specified generic parameter.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v20.2.dll

Declaration

public Task<ClassType> FindObjectAsync<ClassType>(
    PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior,
    CriteriaOperator criteria,
    CancellationToken cancellationToken = default(CancellationToken)
)
Public Function FindObjectAsync(Of ClassType)(
    criteriaEvaluationBehavior As PersistentCriteriaEvaluationBehavior,
    criteria As CriteriaOperator,
    cancellationToken As CancellationToken = Nothing
) As Task(Of ClassType)

Parameters

Name Type Description
criteriaEvaluationBehavior PersistentCriteriaEvaluationBehavior

A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated.

criteria CriteriaOperator

A CriteriaOperator descendant which represents the criteria the persistent object must match.

Optional Parameters

Name Type Default Description
cancellationToken CancellationToken

null

A CancellationToken object that delivers a cancellation notice to the running operation.

Type Parameters

Name
ClassType

Returns

Type Description
Task<ClassType>

A Task that returns an object. This object represents the first persistent object that matches the specified criteria. null (Nothing in Visual Basic) if no persistent object is found that matches the criteria.

Remarks

Below is an example of using the FindObjectAsync<ClassType> method. Here, session is the Session instance.

using System.Threading;
using DevExpress.Data.Filtering;
using DevExpress.Xpo;
// ...
CancellationTokenSource source = new CancellationTokenSource();
CancellationToken cancellationToken = source.Token;
Person personToUpdate = 
    await session.FindObjectAsync<Person>(PersistentCriteriaEvaluationBehavior.BeforeTransaction, 
    CriteriaOperator.Parse("Name='Michael Suyama'"), cancellationToken);
if(personToUpdate != null) {
    personToUpdate.Birthday = new DateTime(1986, 10, 31);
    session.Save(personToUpdate);
}

Persistent objects that are marked as deleted in the database (see Deferred and Immediate Object Deletion) are not included in the search.

See Also