SessionObjectLayer.SelectDataAsync(Session, ObjectsQuery, CriteriaOperatorCollection, CriteriaOperatorCollection, CriteriaOperator, CancellationToken) Method

Retrieves object data from a session asynchronously, according to specified query parameters.

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 Task<List<object[]>> SelectDataAsync(
    Session session,
    ObjectsQuery query,
    CriteriaOperatorCollection properties,
    CriteriaOperatorCollection groupProperties,
    CriteriaOperator groupCriteria,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function SelectDataAsync(
    session As Session,
    query As ObjectsQuery,
    properties As CriteriaOperatorCollection,
    groupProperties As CriteriaOperatorCollection,
    groupCriteria As CriteriaOperator,
    cancellationToken As CancellationToken = Nothing
) As Task(Of List(Of Object()))

Parameters

Name	Type	Description
session	Session	A Session that is used to retrieved persistent objects.
query	ObjectsQuery	An array of ObjectsQuery objects that specifies queries executed to select data.
properties	CriteriaOperatorCollection	A CriteriaOperatorCollection object which specifies object properties to be retrieved.
groupProperties	CriteriaOperatorCollection	A CriteriaOperatorCollection object which specifies the grouping properties.
groupCriteria	CriteriaOperator	A CriteriaOperator descendant which specifies the grouping criteria for the retrieved objects.

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<List<Object[]>>	A Task that returns a list of object arrays. These object arrays match specified query parameters.

Implements

SelectDataAsync(Session, ObjectsQuery, CriteriaOperatorCollection, CriteriaOperatorCollection, CriteriaOperator, CancellationToken)