.NET Framework Class Library
Enumerable..::.First<(Of <(TSource>)>) Method (IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>))

Returns the first element in a sequence that satisfies a specified condition.

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

Visual Basic (Declaration)
<ExtensionAttribute> _
Public Shared Function First(Of TSource) ( _
    source As IEnumerable(Of TSource), _
    predicate As Func(Of TSource, Boolean) _
) As TSource
Visual Basic (Usage)
Dim source As IEnumerable(Of TSource)
Dim predicate As Func(Of TSource, Boolean)
Dim returnValue As TSource

returnValue = source.First(predicate)
C#
public static TSource First<TSource>(
    this IEnumerable<TSource> source,
    Func<TSource, bool> predicate
)
Visual C++
[ExtensionAttribute]
public:
generic<typename TSource>
static TSource First(
    IEnumerable<TSource>^ source, 
    Func<TSource, bool>^ predicate
)
JScript
JScript does not support generic types or methods.

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Collections.Generic..::.IEnumerable<(Of <(TSource>)>)
An IEnumerable<(Of <(T>)>) to return an element from.
predicate
Type: System..::.Func<(Of <(TSource, Boolean>)>)
A function to test each element for a condition.

Return Value

Type: TSource
The first element in the sequence that passes the test in the specified predicate function.

Usage Note

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

ExceptionCondition
ArgumentNullException

source or predicate is nullNothingnullptra null reference (Nothing in Visual Basic).

InvalidOperationException

No element satisfies the condition in predicate.

-or-

The source sequence is empty.

Remarks

The First<(Of <(TSource>)>)(IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>)) method throws an exception if no matching element is found in source. To instead return a default value when no matching element is found, use the FirstOrDefault method.

Examples

The following code example demonstrates how to use First<(Of <(TSource>)>)(IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>)) to return the first element of an array that satisfies a condition.

Visual Basic
' Create an array of integers.
Dim numbers() As Integer = _
    {9, 34, 65, 92, 87, 435, 3, 54, 83, 23, 87, 435, 67, 12, 19}

' Select the first element in the array whose value is greater than 80.
Dim first As Integer = numbers.First(Function(number) number > 80)

' Display the output.
MsgBox(first)

' This code produces the following output:
'
' 92

C#
int[] numbers = { 9, 34, 65, 92, 87, 435, 3, 54, 
                    83, 23, 87, 435, 67, 12, 19 };

int first = numbers.First(number => number > 80);

Console.WriteLine(first);

/*
 This code produces the following output:

 92
*/

Platforms

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.
Version Information

.NET Framework

Supported in: 3.5

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0
See Also

Reference

Tags :


Page view tracker