Session.GetObjectsAsync(ObjectsQuery[], CancellationToken) Method

Asynchronously retrieves persistent objects obtained from specified queries.

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 virtual Task<ICollection[]> GetObjectsAsync(
    ObjectsQuery[] queries,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Overridable Function GetObjectsAsync(
    queries As ObjectsQuery(),
    cancellationToken As CancellationToken = Nothing
) As Task(Of ICollection())

Parameters

Name	Type	Description
queries	ObjectsQuery[]	An array of ObjectsQuery objects that specify 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 a collection of obtained persistent objects.

Remarks

This member supports the internal infrastructure and is not intended to be used directly from your code. To asynchronously get objects from a session, call the LoadAsync method of the XPCollection or XPView component.