DataServiceQuery<TElement>.AddQueryOption(String, Object) メソッド

定義

名前空間:

System.Data.Services.Client

アセンブリ:

System.Data.Services.Client.dll

返されたクエリによって生成される URI でクエリ オプションを設定して、新しい DataServiceQuery<TElement> を作成します。

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)

パラメーター

name

String

追加するクエリ文字列オプションの名前を含む文字列値。

value

Object

クエリ文字列オプションの値を格納するオブジェクト。

戻り値

DataServiceQuery<TElement>

指定されたクエリの URI に追加された要求されたクエリ オプションを含む新しいクエリ。

例

次の例は、運賃が $30 以上の注文だけを返し、結果を降順の日付で並べ替えるシーケンシャルな DataServiceQuery<TElement> メソッド呼び出しと一緒に使用する 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.
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

次の例は、LINQ クエリを作成する方法を示します。このクエリは、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

注釈

クエリ オプションは、 を使用して ?name=value&name2=value2結果の URI に追加されます。 名前が パラメーターに直接マップされvalue、 name が パラメーターで ToString value を呼び出すことによって取得される構文。 name は $ で始まります。

WCF Data Services以外の構文は で$始まらない。 このメソッドを使用して、WCF Data Services以外のクエリ オプションを追加できます。 オプションがWCF Data Servicesクエリ オプションでない場合は、同じクエリ オプションを 2 回追加することは有効です。 基になる URI に既に存在するクエリ オプションを追加した場合、例外がスローされます。