The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Session.SelectDataAsync(XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, Boolean, Int32, SortingCollection, CancellationToken) Method

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

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.2.dll

Declaration

public Task<List<object[]>> SelectDataAsync(
    XPClassInfo classInfo,
    CriteriaOperatorCollection properties,
    CriteriaOperator criteria,
    bool selectDeleted,
    int topSelectedRecords,
    SortingCollection sorting,
    CancellationToken cancellationToken = default(CancellationToken)
)
Public Function SelectDataAsync(
    classInfo As XPClassInfo,
    properties As CriteriaOperatorCollection,
    criteria As CriteriaOperator,
    selectDeleted As Boolean,
    topSelectedRecords As Integer,
    sorting As SortingCollection,
    cancellationToken As CancellationToken = Nothing
) As Task(Of List(Of Object()))
public Task<List<object[]>> SelectDataAsync(
    XPClassInfo classInfo,
    CriteriaOperatorCollection properties,
    CriteriaOperator criteria,
    bool selectDeleted,
    int topSelectedRecords,
    SortingCollection sorting,
    CancellationToken cancellationToken = default(CancellationToken)
)
Public Function SelectDataAsync(
    classInfo As XPClassInfo,
    properties As CriteriaOperatorCollection,
    criteria As CriteriaOperator,
    selectDeleted As Boolean,
    topSelectedRecords As Integer,
    sorting As SortingCollection,
    cancellationToken As CancellationToken = Nothing
) As Task(Of List(Of Object()))

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted Boolean

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords Int32

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

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

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object that contains metadata information. This data specifies which objects need to be retrieved.

properties CriteriaOperatorCollection

A CriteriaOperatorCollection object which specifies object properties to be retrieved.

criteria CriteriaOperator

A CriteriaOperator descendant which specifies the objects to be retrieved.

selectDeleted Boolean

A Boolean value that specifies whether the objects marked as deleted must be retrieved.

topSelectedRecords Int32

An integer value which specifies the maximum number of objects to be retrieved.

sorting SortingCollection

A SortingCollection object that specifies the sort order for the list of the retrieved objects.

cancellationToken CancellationToken

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 represent object properties retrieved from a data store.

Returns

Type Description
Task<List<Object[]>>

A Task that returns a list of object arrays. These object arrays represent object properties retrieved from a data store.

Remarks

This method is intended for internal use. To get objects from a session, use the XPCollection and XPView components.

See Also