Session.FindObjectAsync(PersistentCriteriaEvaluationBehavior, XPClassInfo, CriteriaOperator, Boolean, CancellationToken) Method
Asynchronously searches for the first object that matches the specified criteria.
Namespace: DevExpress.Xpo
Assembly: DevExpress.Xpo.v18.2.dll
Declaration
public Task<object> FindObjectAsync(
PersistentCriteriaEvaluationBehavior criteriaEvaluationBehavior,
XPClassInfo classInfo,
CriteriaOperator criteria,
bool selectDeleted,
CancellationToken cancellationToken = default(CancellationToken)
)
Parameters
Name | Type | Description |
---|---|---|
criteriaEvaluationBehavior | PersistentCriteriaEvaluationBehavior | A PersistentCriteriaEvaluationBehavior enumeration value that specifies how the persistent criteria is evaluated. |
classInfo | XPClassInfo | An XPClassInfo object which contains the metadata information. This data specifies which class needs to be searched. |
criteria | CriteriaOperator | A CriteriaOperator descendant which represents the criteria the persistent object must match. |
selectDeleted | Boolean | true, to include persistent objects marked as deleted into the search; otherwise, false. |
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<Object> | 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
Persistent objects that are marked as deleted in the database (see Deferred and Immediate Object Deletion) are can be optionally included in the search using the selectDeleted parameter.