Queryable::OrderBy<TSource, TKey> Method (IQueryable<TSource>, Expression<Func<TSource, TKey>>, IComparer<TKey>)
Sorts the elements of a sequence in ascending order by using a specified comparer.
Assemblies: System.Linq.Queryable (in System.Linq.Queryable.dll)
System.Core (in System.Core.dll)
[ExtensionAttribute] public: generic<typename TSource, typename TKey> static IOrderedQueryable<TSource>^ OrderBy( IQueryable<TSource>^ source, Expression<Func<TSource, TKey>^>^ keySelector, IComparer<TKey>^ comparer )
The type of the elements of source.
The type of the key returned by the function that is represented by keySelector.
- Type: System.Linq::IQueryable<>
A sequence of values to order.
- Type: System.Linq.Expressions::Expression<Func<, >>
A function to extract a key from an element.
Return ValueType: System.Linq::IOrderedQueryable<>
An IOrderedQueryable<T> whose elements are sorted according to a key.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable<>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T, TResult> types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.
The method generates a MethodCallExpression that represents calling itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery<TElement>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter. The result of calling CreateQuery<TElement>(Expression) is cast to type IOrderedQueryable<T> and returned.
The query behavior that occurs as a result of executing an expression tree that represents calling depends on the implementation of the type of the source parameter. The expected behavior is that it sorts the elements of source based on the key obtained by invoking keySelector on each element of source. The comparer parameter is used to compare keys.