Enumerable..::.FirstOrDefault<(Of <(TSource>)>) Method (IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>)) Home
This page is specific to:.NET Framework Version:3.5Silverlight 34.0
.NET Framework Class Library
Enumerable..::.FirstOrDefault<(Of <(TSource>)>) Method (IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>))

Returns the first element of the sequence that satisfies a condition or a default value if no such element is found.

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

'Usage

Dim source As IEnumerable(Of TSource)
Dim predicate As Func(Of TSource, Boolean)
Dim returnValue As TSource

returnValue = source.FirstOrDefault(predicate)

'Declaration

<ExtensionAttribute> _
Public Shared Function FirstOrDefault(Of TSource) ( _
    source As IEnumerable(Of TSource), _
    predicate As Func(Of TSource, Boolean) _
) As TSource

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
default(TSource) if source is empty or if no element passes the test specified by predicate; otherwise, the first element in source that passes the test specified by predicate.

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).

Remarks

The default value for reference and nullable types is nullNothingnullptra null reference (Nothing in Visual Basic).

Examples

The following code example demonstrates how to use FirstOrDefault<(Of <(TSource>)>)(IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Boolean>)>)) by passing in a predicate. In the second call to the method, there is no element in the array that satisfies the condition.

' Create an array of strings.
Dim names() As String = _
    {"Hartono, Tommy", "Adams, Terry", "Andersen, Henriette Thaulow", "Hedlund, Magnus", "Ito, Shu"}

' Select the first string in the array whose length is greater than 20.
Dim firstLongName As String = _
    names.FirstOrDefault(Function(name) name.Length > 20)

' Display the output.
MsgBox("The first long name is " & firstLongName)

' Select the first string in the array whose length is greater than 30,
' or a default value if there are no such strings in the array.
Dim firstVeryLongName As String = _
    names.FirstOrDefault(Function(name) name.Length > 30)

Dim text As String = IIf(String.IsNullOrEmpty(firstVeryLongName), "not a", "a")

MsgBox("There is " & text & " name longer than 30 characters.")

' This code produces the following output:
'
' The first long name is Andersen, Henriette Thaulow
'
' There is not a name longer than 30 characters.



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

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View