Enumerable.GroupBy(Of TSource, TKey) Method (IEnumerable(Of TSource), 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.
Assembly: System.Core (in System.Core.dll)
'Declaration <ExtensionAttribute> _ Public Shared Function GroupBy(Of TSource, TKey) ( _ source As IEnumerable(Of TSource), _ keySelector As Func(Of TSource, TKey), _ comparer As IEqualityComparer(Of TKey) _ ) As IEnumerable(Of IGrouping(Of TKey, TSource)) 'Usage Dim source As IEnumerable(Of TSource) Dim keySelector As Func(Of TSource, TKey) Dim comparer As IEqualityComparer(Of TKey) Dim returnValue As IEnumerable(Of IGrouping(Of TKey, TSource)) returnValue = source.GroupBy(keySelector, _ comparer)
The type of the elements of source.
The type of the key returned by keySelector.
- Type: System.Collections.Generic.IEnumerable(Of )
An IEnumerable(Of T) whose elements to group.
- Type: System.Func(Of , )
A function to extract the key for each element.
Return ValueType: System.Collections.Generic.IEnumerable(Of IGrouping(Of , ))
An IEnumerable<IGrouping<TKey, TSource>> in C# or IEnumerable(Of IGrouping(Of TKey, TSource)) in Visual Basic where each IGrouping(Of TKey, TElement) object contains a collection of objects and a key.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(Of ). 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 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 method returns a collection of IGrouping(Of TKey, TElement) objects, one for each distinct key that was encountered. An IGrouping(Of TKey, TElement) is an IEnumerable(Of T) that also has a key associated with its elements.
The IGrouping(Of 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(Of TKey, TElement). Elements in a grouping are yielded in the order they appear in source.
If comparer is Nothing, 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).
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.