IObjectLayerAsync.GetObjectsByKeyAsync(Session, ObjectsByKeyQuery[], 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#

Task<ICollection[]> GetObjectsByKeyAsync(
    Session session,
    ObjectsByKeyQuery[] queries,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Function GetObjectsByKeyAsync(
    session As Session,
    queries As ObjectsByKeyQuery(),
    cancellationToken As CancellationToken = Nothing
) As Task(Of ICollection())

Parameters

Name	Type	Description
session	Session	A Session that is used to load persistent objects.
queries	ObjectsByKeyQuery[]	An array of ObjectsQuery objects that specifies queries executed to retrieve persistent 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<ICollection[]>	A Task that returns an array of object collections. These object collections match specified query parameters.