XPQueryExtensions.EnumerateAsync<T>(IQueryable<T>, XPQueryExtensions.AsyncEnumerateCallback<T>) Method

Asynchronously enumerates a specified query and notifies upon completion.

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 static void EnumerateAsync<T>(
    this IQueryable<T> query,
    XPQueryExtensions.AsyncEnumerateCallback<T> callback
)

VB.NET

<ExtensionAttribute>
Public Shared Sub EnumerateAsync(Of T)(
    query As IQueryable(Of T),
    callback As XPQueryExtensions.AsyncEnumerateCallback(Of T)
)

Parameters

Name	Type	Description
query	IQueryable<T>	An XPQuery<T> to be enumerated.
callback	DevExpress.Xpo.XPQueryExtensions.AsyncEnumerateCallback<T>	An AsyncEnumerateCallback<T> delegate, which is a method to be called after all elements in the query are enumerated.

Type Parameters

Name
T

Remarks

Example:

C#

using System.Linq;
using DevExpress.Xpo;
using System.Collections.Generic;

// ...

var data = from c in session1.Query<Person>()
           where c.LastName.StartsWith("A")
           select c;

// Asynchronously loads XPQuery and enumerates it
data.EnumerateAsync<Contact>(delegate(IEnumerable<Contact> objects, Exception ex)
{
    // Process loaded objects here
});

VB.NET

'NOTE: This code snippet uses implicit typing. 
'You will need to set 'Option Infer On' in the VB file or set 'Option Infer' at the project level:

Imports System.Linq
Imports DevExpress.Xpo
Imports System.Collections.Generic

' ...

Private data = from c in session1.Query(Of Person)() where c.LastName.StartsWith("A") select c

' Asynchronously loads XPQuery and enumerates it
data.EnumerateAsync(Of Contact)(Function(objects, ex) AnonymousMethod1(objects, ex))

Private Function AnonymousMethod1(ByVal objects As IEnumerable(Of Contact), _
ByVal ex As Exception) As Boolean
    ' Process loaded objects here
    Return True
End Function