'Usage

Dim source As IEnumerable(Of TSource)
Dim count As Integer
Dim returnValue As IEnumerable(Of TSource)

returnValue = source.Take(count)

'Declaration

<ExtensionAttribute> _
Public Shared Function Take(Of TSource) ( _
    source As IEnumerable(Of TSource), _
    count As Integer _
) As IEnumerable(Of TSource)

Usage Note

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<(Of <(TSource>)>) enumerates source and yields elements until count elements have been yielded or source contains no more elements.

If count is less than or equal to zero, source is not enumerated and an empty IEnumerable<(Of <(T>)>) is returned.

The Take<(Of <(TSource>)>) and Skip<(Of <(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<(Of <(TSource>)>).

The following code example demonstrates how to use Take<(Of <(TSource>)>) to return elements from the start of a sequence.

' Create an array of Integer values that represent grades.
Dim grades() As Integer = {59, 82, 70, 56, 92, 98, 85}

' Get the highest three grades by first sorting
' them in descending order and then taking the
' first three values.
Dim topThreeGrades As IEnumerable(Of Integer) = _
    grades _
    .OrderByDescending(Function(grade) grade) _
    .Take(3)

' Display the results.
Dim output As New System.Text.StringBuilder("The top three grades are:" & vbCrLf)
For Each grade As Integer In topThreeGrades
    output.AppendLine(grade)
Next
MsgBox(output.ToString())

' This code produces the following output:
'
' The top three grades are:
' 98
' 92
' 85

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

.NET Framework

.NET Compact Framework

XNA Framework

Reference

Other Resources