Enumerable.Take<TSource> Method (IEnumerable<TSource>, Int32)
Returns a specified number of contiguous elements from the start of a sequence.
Assembly: System.Core (in System.Core.dll)
public static IEnumerable<TSource> Take<TSource>( this IEnumerable<TSource> source, int count )
Parameters
- source
-
Type:
System.Collections.Generic.IEnumerable<TSource>
The sequence to return elements from.
- count
-
Type:
System.Int32
The number of elements to return.
Return Value
Type: System.Collections.Generic.IEnumerable<TSource>An IEnumerable<T> that contains the specified number of elements from the start of the input sequence.
Type Parameters
- TSource
The type of the elements of source.
| Exception | Condition |
|---|---|
| ArgumentNullException | source 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.
Take<TSource> enumerates source and yields elements until count elements have been yielded or sourcecontains no more elements. If count exceeds the number of elements in source, all elements of sourceare returned.
If count is less than or equal to zero, source is not enumerated and an empty IEnumerable<T> is returned.
The Take<TSource> and Skip<TSource> methods are functional complements. Given a sequence coll and an integer n, concatenating the results of coll.Take(n) and coll.Skip(n) yields the same sequence as coll.
In Visual Basic query expression syntax, a Take clause translates to an invocation of Take<TSource>.
The following code example demonstrates how to use Take<TSource> to return elements from the start of a sequence.
int[] grades = { 59, 82, 70, 56, 92, 98, 85 }; IEnumerable<int> topThreeGrades = grades.OrderByDescending(grade => grade).Take(3); Console.WriteLine("The top three grades are:"); foreach (int grade in topThreeGrades) { Console.WriteLine(grade); } /* This code produces the following output: The top three grades are: 98 92 85 */
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1