Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
  • None
User Action:
  • None

DataServiceQuery<TElement>.AddQueryOption Method

Creates a new DataServiceQuery<TElement> with the query option set in the URI generated by the returned query.

Namespace:  System.Data.Services.Client
Assembly:  Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)
Public Function AddQueryOption ( _
	name As String, _
	value As Object _
) As DataServiceQuery(Of TElement)
Dim instance As DataServiceQuery 
Dim name As String 
Dim value As Object 
Dim returnValue As DataServiceQuery(Of TElement)

returnValue = instance.AddQueryOption(name, _
	value)

Parameters

name
Type: System.String
The string value that contains the name of the query string option to add.
value
Type: System.Object
The object that contains the value of the query string option.

Return Value

Type: System.Data.Services.Client.DataServiceQuery<TElement>
A new query that includes the requested query option appended to the URI of the supplied query

The query options are added to the resultant URI using ?name=value&name2=value2… syntax where the name maps directly to the name parameter and the value is obtained by calling ToString on the value parameter. The name starts with $.

Non-WCF Data Services syntax does not start with $. Non-WCF Data Services query options can be added using this method. It is legal to add the same query option twice if the option is not an WCF Data Services query option. If a query option is added that is already present in the underlying URI, an exception is thrown.

The $select query option cannot be added to a query URI by using the AddQueryOption(String, Object) method. We recommend that you use the LINQ Select<TSource, TResult>(IEnumerable<TSource>, Func<TSource, TResult>) method and have the client generate the $select query option in the request URI.