GroupBy(TSource, TKey) Method (IQueryable(TSource), Expression(Func(TSource, TKey)), IEqualityComparer(TKey))

Queryable.GroupBy(Of TSource, TKey) Method (IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IEqualityComparer(Of TKey))


Groups the elements of a sequence according to a specified key selector function and compares the keys by using a specified comparer.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)

Public Shared Function GroupBy(Of TSource, TKey) (
	source As IQueryable(Of TSource),
	keySelector As Expression(Of Func(Of TSource, TKey)),
	comparer As IEqualityComparer(Of TKey)
) As IQueryable(Of IGrouping(Of TKey, TSource))


Type: System.Linq.IQueryable(Of TSource)

An IQueryable(Of T) whose elements to group.

Type: System.Linq.Expressions.Expression(Of Func(Of TSource, TKey))

A function to extract the key for each element.

Type: System.Collections.Generic.IEqualityComparer(Of TKey)

An IEqualityComparer(Of T) to compare keys.

Return Value

Type: System.Linq.IQueryable(Of IGrouping(Of TKey, TSource))

An IQueryable<IGrouping<TKey, TSource>> in C# or IQueryable(Of IGrouping(Of TKey, TSource)) in Visual Basic where each IGrouping(Of TKey, TElement) contains a sequence of objects and a key.

Type Parameters


The type of the elements of source.


The type of the key returned by the function represented in keySelector.

Exception Condition

source or keySelector or comparer is null.

This method has at least one parameter of type Expression(Of TDelegate) whose type argument is one of the Func(Of T, TResult) types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression(Of TDelegate).

The GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IEqualityComparer(Of TKey)) method generates a MethodCallExpression that represents calling GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IEqualityComparer(Of TKey)) itself as a constructed generic method. It then passes the MethodCallExpression to the CreateQuery(Of TElement)(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

The query behavior that occurs as a result of executing an expression tree that represents calling GroupBy(Of TSource, TKey)(IQueryable(Of TSource), Expression(Of Func(Of TSource, TKey)), IEqualityComparer(Of TKey)) depends on the implementation of the type of the source parameter. The expected behavior is that it groups the elements of source by a key value. The key value is obtained by invoking keySelector on each element, and key values are compared by using comparer.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.1
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft