.NET Framework Class Library
EnumerableGroupByTSource, TKey Method (IEnumerableTSource, FuncTSource, TKey)

Groups the elements of a sequence according to a specified key selector function.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)
Syntax
<[%$TOPIC/bb534501_en-us_VS_110_1_0_0_0_0%]> _
Public Shared Function GroupBy(Of TSource, TKey) ( _
	source As [%$TOPIC/bb534501_en-us_VS_110_1_0_0_0_1%](Of TSource), _
	keySelector As [%$TOPIC/bb534501_en-us_VS_110_1_0_0_0_2%](Of TSource, TKey) _
) As [%$TOPIC/bb534501_en-us_VS_110_1_0_0_0_3%](Of [%$TOPIC/bb534501_en-us_VS_110_1_0_0_0_4%](Of TKey, TSource))
public static [%$TOPIC/bb534501_en-us_VS_110_1_0_1_0_0%]<[%$TOPIC/bb534501_en-us_VS_110_1_0_1_0_1%]<TKey, TSource>> GroupBy<TSource, TKey>(
	this [%$TOPIC/bb534501_en-us_VS_110_1_0_1_0_2%]<TSource> source,
	[%$TOPIC/bb534501_en-us_VS_110_1_0_1_0_3%]<TSource, TKey> keySelector
)
[[%$TOPIC/bb534501_en-us_VS_110_1_0_2_0_0%]]
public:
generic<typename TSource, typename TKey>
static [%$TOPIC/bb534501_en-us_VS_110_1_0_2_0_1%]<[%$TOPIC/bb534501_en-us_VS_110_1_0_2_0_2%]<TKey, TSource>^>^ GroupBy(
	[%$TOPIC/bb534501_en-us_VS_110_1_0_2_0_3%]<TSource>^ source, 
	[%$TOPIC/bb534501_en-us_VS_110_1_0_2_0_4%]<TSource, TKey>^ keySelector
)
static member GroupBy : 
        source:[%$TOPIC/bb534501_en-us_VS_110_1_0_3_0_0%]<'TSource> * 
        keySelector:[%$TOPIC/bb534501_en-us_VS_110_1_0_3_0_1%]<'TSource, 'TKey> -> [%$TOPIC/bb534501_en-us_VS_110_1_0_3_0_2%]<[%$TOPIC/bb534501_en-us_VS_110_1_0_3_0_3%]<'TKey, 'TSource>> 

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

Parameters

source
Type: System.Collections.GenericIEnumerableTSource

An IEnumerableT whose elements to group.

keySelector
Type: SystemFuncTSource, TKey

A function to extract the key for each element.

Return Value

Type: System.Collections.GenericIEnumerable IGroupingTKey, TSource
An IEnumerable<IGrouping<TKey, TSource>> in C# or IEnumerable(Of IGrouping(Of TKey, TSource)) in Visual Basic where each IGroupingTKey, TElement object contains a sequence of objects and a key.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. 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).
Exceptions
ExceptionCondition
ArgumentNullException

source or keySelector is .

Remarks

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 GroupByTSource, TKey(IEnumerableTSource, FuncTSource, TKey) method returns a collection of IGroupingTKey, TElement objects, one for each distinct key that was encountered. An IGroupingTKey, TElement is an IEnumerableT that also has a key associated with its elements.

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

The default equality comparer Default is used to compare keys.

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).

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.