The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Enumerable.GroupBy<TSource, TKey> Method (IEnumerable<TSource>, Func<TSource, TKey>, IEqualityComparer<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 static IEnumerable<IGrouping<TKey, TSource>> GroupBy<TSource, TKey>(
	this IEnumerable<TSource> source,
	Func<TSource, TKey> keySelector,
	IEqualityComparer<TKey> comparer


Type: System.Collections.Generic.IEnumerable<TSource>

An IEnumerable<T> whose elements to group.

Type: System.Func<TSource, TKey>

A function to extract the key for each element.

Type: System.Collections.Generic.IEqualityComparer<TKey>

An IEqualityComparer<T> to compare keys.

Return Value

Type: System.Collections.Generic.IEnumerable<IGrouping<TKey, TSource>>

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

Type Parameters


The type of the elements of source.


The type of the key returned by keySelector.

Exception Condition

source or keySelector is null.

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

The GroupBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>) method returns a collection of IGrouping<TKey, TElement> objects, one for each distinct key that was encountered. An IGrouping<TKey, TElement> is an IEnumerable<T> that also has a key associated with its elements.

The IGrouping<TKey, TElement> objects are yielded in an order based on the order of the elements in source that produced the first key of each IGrouping<TKey, TElement>. Elements in a grouping are yielded in the order they appear in source.

If comparer is null, the default equality comparer Default is used to compare keys.

If two keys are considered equal according to comparer, the first key is chosen as the key for that grouping.

In query expression syntax, a group by (Visual C#) or Group By Into (Visual Basic) clause translates to an invocation of GroupBy. For more information and usage examples, see group clause (C# Reference) and Group By Clause (Visual Basic).

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.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft