Export (0) Print
Expand All

Enumerable.Take(TSource) Method

Returns a specified number of contiguous elements from the start of a sequence.

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

static member Take : 
        source:IEnumerable<'TSource> * 
        count:int -> IEnumerable<'TSource> 

Type Parameters

TSource

The type of the elements of source.

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.

Usage Note

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

ExceptionCondition
ArgumentNullException

source is a null reference (Nothing in Visual Basic).

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 source contains no more elements. If count exceeds the number of elements in source, all elements of source are 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.

No code example is currently available or this language may not be supported.

.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

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.

Show:
© 2014 Microsoft