DataServiceContext.EndExecute<TElement> Method (IAsyncResult)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Called to complete the BeginExecute<TElement>.

Namespace:   System.Data.Services.Client
Assembly:  System.Data.Services.Client (in System.Data.Services.Client.dll)

public IEnumerable<TElement> EndExecute<TElement>(
	IAsyncResult asyncResult


Type: System.IAsyncResult

IAsyncResult object.

Return Value

Type: System.Collections.Generic.IEnumerable<TElement>

The results returned by the query operation.

Type Parameters


The type returned by the query.

Exception Condition

When asyncResult is null.


When asyncResult did not originate from this DataServiceContext instance.


When the EndExecute<TElement> method was previously called.


When an error is raised either during execution of the request or when it converts the contents of the response message into objects.


When an error is raised either during execution of the request or when it converts the contents of the response message into objects.

According to the standard begin-end asynchronous pattern, the provided callback is invoked when query results are retrieved. For more information, see Asynchronous Operations (WCF Data Services).

When the callback is invoked, all results have been read from the HTTP stream, but they have not been processed; no local user-facing objects have been materialized or modified and identity resolution has not occurred. When EndExecute<TElement> is invoked, a DataServiceResponse is created and returned but the results still have not been processed. Identity resolution, object materialization, and manipulation occur only when the user enumerates the results.

The following example shows how to execute an asynchronous query by calling the BeginExecute method to start the query. The inline delegate calls the EndExecute method to display the query results. This example uses the DataServiceContext generated by the Add Service Reference tool based on the Northwind data service, which is created when you complete the WCF Data Services .

public static void BeginExecuteCustomersQuery()
    // Create the DataServiceContext using the service URI.
    NorthwindEntities context = new NorthwindEntities(svcUri);

    // Define the query to execute asynchronously that returns 
    // all customers with their respective orders.
    DataServiceQuery<Customer> query = (DataServiceQuery<Customer>)(from cust in context.Customers.Expand("Orders")
                                       where cust.CustomerID == "ALFKI"
                                       select cust);

        // Begin query execution, supplying a method to handle the response
        // and the original query object to maintain state in the callback.
        query.BeginExecute(OnCustomersQueryComplete, query);
    catch (DataServiceQueryException ex)
        throw new ApplicationException(
            "An error occurred during query execution.", ex);

// Handle the query callback.
private static void OnCustomersQueryComplete(IAsyncResult result)
    // Get the original query from the result.
    DataServiceQuery<Customer> query = 
        result as DataServiceQuery<Customer>;

    foreach (Customer customer in query.EndExecute(result))
        Console.WriteLine("Customer Name: {0}", customer.CompanyName);
        foreach (Order order in customer.Orders)
            Console.WriteLine("Order #: {0} - Freight $: {1}",
                order.OrderID, order.Freight);

.NET Framework
Available since 3.5
Available since 2.0
Return to top