DataServiceQuery<TElement>.AddQueryOption(String, Object) Método

Definição

Namespace:

System.Data.Services.Client

Assembly:

System.Data.Services.Client.dll

Cria uma nova DataServiceQuery<TElement> com a opção de consulta definida no URI gerado pela consulta retornada.

public:
 System::Data::Services::Client::DataServiceQuery<TElement> ^ AddQueryOption(System::String ^ name, System::Object ^ value);

public System.Data.Services.Client.DataServiceQuery<TElement> AddQueryOption (string name, object value);

member this.AddQueryOption : string * obj -> System.Data.Services.Client.DataServiceQuery<'Element>

Public Function AddQueryOption (name As String, value As Object) As DataServiceQuery(Of TElement)

Parâmetros

name

String

O valor de cadeia de caracteres que contém o nome da opção de cadeia de consulta a ser adicionada.

value

Object

O objeto que contém o valor da opção de cadeia de consulta.

Retornos

DataServiceQuery<TElement>

Uma nova consulta que inclui a opção de consulta solicitada acrescentada ao URI da consulta fornecida.

Exemplos

O exemplo a seguir mostra um DataServiceQuery<TElement> que é usado com chamadas de método sequencial AddQueryOption para retornar apenas pedidos com um custo de frete superior a US$ 30 e para ordenar os resultados até a data do envio em ordem decrescente.

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

// Define a query for orders with a Freight value greater than 30
// and that is ordered by the ship date, descending.
DataServiceQuery<Order> selectedOrders = context.Orders
    .AddQueryOption("$filter", "Freight gt 30")
    .AddQueryOption("$orderby", "OrderID desc");

try
{
    // Enumerate over the results of the query.
    foreach (Order order in selectedOrders)
    {
        Console.WriteLine("Order ID: {0} - Ship Date: {1} - Freight: {2}",
            order.OrderID, order.ShippedDate, order.Freight);
    }
}
catch (DataServiceQueryException ex)
{
    throw new ApplicationException(
        "An error occurred during query execution.", ex);
}

' Create the DataServiceContext using the service URI.
Dim context = New NorthwindEntities(svcUri)

' Define a query for orders with a Freight value greater than 30
' and that is ordered by the ship date, descending.
Dim selectedOrders As DataServiceQuery(Of Order) = context.Orders _
.AddQueryOption("$filter", "Freight gt 30") _
.AddQueryOption("$orderby", "OrderID desc")

Try
    ' Enumerate over the results of the query.
    For Each order As Order In selectedOrders
        Console.WriteLine("Order ID: {0} - Ship Date: {1} - Freight: {2}", _
                order.OrderID, order.ShippedDate, order.Freight)
    Next
Catch ex As DataServiceQueryException
    Throw New ApplicationException( _
            "An error occurred during query execution.", ex)
End Try

O exemplo a seguir mostra como compor uma consulta LINQ equivalente à consulta anterior que usou AddQueryOption.

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

// Define a query for orders with a Freight value greater than 30
// and that is ordered by the ship date, descending.
var selectedOrders = from o in context.Orders
                     where o.Freight > 30
                     orderby o.ShippedDate descending
                     select o;

try
{
    // Enumerate over the results of the query.
    foreach (Order order in selectedOrders)
    {
        Console.WriteLine("Order ID: {0} - Ship Date: {1} - Freight: {2}",
            order.OrderID, order.ShippedDate, order.Freight);
    }
}
catch (DataServiceQueryException ex)
{
    throw new ApplicationException(
        "An error occurred during query execution.", ex);
}

' Create the DataServiceContext using the service URI.
Dim context = New NorthwindEntities(svcUri)

' Define a query for orders with a Freight value greater than 30
' and that is ordered by the ship date, descending.
Dim selectedOrders = From o In context.Orders _
        Where (o.Freight > 30) _
        Order By o.ShippedDate Descending _
        Select o

Try
    ' Enumerate over the results of the query.
    For Each order As Order In selectedOrders
        Console.WriteLine("Order ID: {0} - Ship Date: {1} - Freight: {2}", _
                order.OrderID, order.ShippedDate, order.Freight)
    Next
Catch ex As DataServiceQueryException
    Throw New ApplicationException( _
            "An error occurred during query execution.", ex)
End Try

Comentários

As opções de consulta são adicionadas ao URI resultante usando ?name=value&name2=value2... sintaxe em que o nome é mapeado diretamente para o name parâmetro e o value é obtido chamando ToString no value parâmetro . O name começa com $.

A sintaxe não WCF Data Services não começa com $. Opções de consulta não WCF Data Services podem ser adicionadas usando esse método. É legal adicionar a mesma opção de consulta duas vezes se a opção não for uma opção de consulta WCF Data Services. Se uma opção de consulta for adicionada que já esteja presente no URI subjacente, uma exceção será gerada.