Queryable.FirstOrDefault メソッド

定義

シーケンスの最初の要素を返します。要素が見つからない場合は既定値を返します。Returns the first element of a sequence, or a default value if no element is found.

オーバーロード

FirstOrDefault<TSource>(IQueryable<TSource>)

シーケンスの最初の要素を返します。シーケンスに要素が含まれていない場合は既定値を返します。Returns the first element of a sequence, or a default value if the sequence contains no elements.

FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)

指定された条件を満たす、シーケンスの最初の要素を返します。このような要素が見つからない場合は既定値を返します。Returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found.

FirstOrDefault<TSource>(IQueryable<TSource>)

シーケンスの最初の要素を返します。シーケンスに要素が含まれていない場合は既定値を返します。Returns the first element of a sequence, or a default value if the sequence contains no elements.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource FirstOrDefault(System::Linq::IQueryable<TSource> ^ source);
public static TSource FirstOrDefault<TSource> (this System.Linq.IQueryable<TSource> source);
static member FirstOrDefault : System.Linq.IQueryable<'Source> -> 'Source
<Extension()>
Public Function FirstOrDefault(Of TSource) (source As IQueryable(Of TSource)) As TSource

型パラメーター

TSource

source の要素の型。The type of the elements of source.

パラメーター

source
IQueryable<TSource>

最初の要素を返す IQueryable<T>The IQueryable<T> to return the first element of.

戻り値

TSource

が空の場合は defaultTSource(source)。それ以外の場合は source の最初の要素。default(TSource) if source is empty; otherwise, the first element in source.

例外

sourcenull です。source is null.

次のコード例は、空のシーケンスで FirstOrDefault<TSource>(IQueryable<TSource>) を使用する方法を示しています。The following code example demonstrates how to use FirstOrDefault<TSource>(IQueryable<TSource>) on an empty sequence.

// Create an empty array.
int[] numbers = { };
// Get the first item in the array, or else the 
// default value for type int (0).
int first = numbers.AsQueryable().FirstOrDefault();

Console.WriteLine(first);

/*
    This code produces the following output:

    0
*/

' Create an empty array.
Dim numbers() As Integer = {}
' Get the first item in the array, or else the 
' default value for type int, which is 0.
Dim first As Integer = numbers.AsQueryable().FirstOrDefault()

MsgBox(first)

' This code produces the following output:

' 0

default(TSource) の値は、コレクションに要素が含まれていない場合に使用する既定値ではない場合があります。Sometimes the value of default(TSource) is not the default value that you want to use if the collection contains no elements. 不要な既定値の結果を確認し、必要に応じて変更するのではなく、DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) メソッドを使用して、コレクションが空の場合に使用する既定値を指定できます。Instead of checking the result for the unwanted default value and then changing it if necessary, you can use the DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) method to specify the default value that you want to use if the collection is empty. 次に、First<TSource>(IQueryable<TSource>) を呼び出して、最初の要素を取得します。Then, call First<TSource>(IQueryable<TSource>) to obtain the first element. 次のコード例では、2つの方法を使用して、数値の月のコレクションが空の場合に既定値1を取得します。The following code example uses both techniques to obtain a default value of 1 if a collection of numeric months is empty. 整数の既定値は0であるため、どの月にも対応していません。そのため、既定値は1として指定する必要があります。Because the default value for an integer is 0, which does not correspond to any month, the default value must be specified as 1 instead. 最初の結果変数は、クエリの完了後に不要な既定値に対してチェックされます。The first result variable is checked for the unwanted default value after the query is completed. 2番目の結果変数は、DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) を呼び出して既定値1を指定することによって取得されます。The second result variable is obtained by calling DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) to specify a default value of 1.

List<int> months = new List<int> { };

// Setting the default value to 1 after the query.
int firstMonth1 = months.AsQueryable().FirstOrDefault();
if (firstMonth1 == 0)
{
    firstMonth1 = 1;
}
Console.WriteLine("The value of the firstMonth1 variable is {0}", firstMonth1);

// Setting the default value to 1 by using DefaultIfEmpty() in the query.
int firstMonth2 = months.AsQueryable().DefaultIfEmpty(1).First();
Console.WriteLine("The value of the firstMonth2 variable is {0}", firstMonth2);

/*
 This code produces the following output:

 The value of the firstMonth1 variable is 1
 The value of the firstMonth2 variable is 1
*/

Dim months As New List(Of Integer)(New Integer() {})

' Setting the default value to 1 after the query.
Dim firstMonth1 As Integer = months.AsQueryable().FirstOrDefault()
If firstMonth1 = 0 Then
    firstMonth1 = 1
End If
MsgBox(String.Format("The value of the firstMonth1 variable is {0}", firstMonth1))

' Setting the default value to 1 by using DefaultIfEmpty() in the query.
Dim firstMonth2 As Integer = months.AsQueryable().DefaultIfEmpty(1).First()
MsgBox(String.Format("The value of the firstMonth2 variable is {0}", firstMonth2))

' This code produces the following output:
'
' The value of the firstMonth1 variable is 1
' The value of the firstMonth2 variable is 1

注釈

FirstOrDefault<TSource>(IQueryable<TSource>) メソッドは、構築されたジェネリックメソッドとしての呼び出し FirstOrDefault<TSource>(IQueryable<TSource>) 自体を表す MethodCallExpression を生成します。The FirstOrDefault<TSource>(IQueryable<TSource>) method generates a MethodCallExpression that represents calling FirstOrDefault<TSource>(IQueryable<TSource>) itself as a constructed generic method. 次に、source パラメーターの Provider プロパティによって表される IQueryProviderExecute<TResult>(Expression) メソッドに MethodCallExpression を渡します。It then passes the MethodCallExpression to the Execute<TResult>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

FirstOrDefault<TSource>(IQueryable<TSource>) の呼び出しを表す式ツリーを実行した結果として発生するクエリ動作は、source パラメーターの型の実装によって異なります。The query behavior that occurs as a result of executing an expression tree that represents calling FirstOrDefault<TSource>(IQueryable<TSource>) depends on the implementation of the type of the source parameter. 期待される動作は、source内の最初の要素を返すことです。 source が空の場合は既定値が返されます。The expected behavior is that it returns the first element in source, or a default value if source is empty.

FirstOrDefault メソッドには、source が空の場合に返す既定値を指定する方法は用意されていません。The FirstOrDefault method does not provide a way to specify the default value to return if source is empty. default(TSource)以外の既定値を指定する場合は、「例」のセクションで説明されているように、DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) メソッドを使用します。If you want to specify a default value other than default(TSource), use the DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) method as described in the Example section.

FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)

指定された条件を満たす、シーケンスの最初の要素を返します。このような要素が見つからない場合は既定値を返します。Returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource FirstOrDefault(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate);
public static TSource FirstOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate);
static member FirstOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> -> 'Source
<Extension()>
Public Function FirstOrDefault(Of TSource) (source As IQueryable(Of TSource), predicate As Expression(Of Func(Of TSource, Boolean))) As TSource

型パラメーター

TSource

source の要素の型。The type of the elements of source.

パラメーター

source
IQueryable<TSource>

返される要素が含まれる IQueryable<T>An IQueryable<T> to return an element from.

predicate
Expression<Func<TSource,Boolean>>

各要素が条件を満たしているかどうかをテストする関数。A function to test each element for a condition.

戻り値

TSource

が空の場合または で指定されたテストに合格する要素がない場合は TSourcedefaultsource(predicate)。それ以外の場合は、source で指定されたテストに合格する、predicate の最初の要素。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.

例外

source 、または predicatenullです。source or predicate is null.

次のコード例は、述語を渡すことによって FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) を使用する方法を示しています。The following code example demonstrates how to use FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) by passing in a predicate. 2番目のクエリでは、条件を満たす要素がシーケンス内に存在しません。In the second query, there is no element in the sequence that satisfies the condition.

string[] names = { "Hartono, Tommy", "Adams, Terry", 
                     "Andersen, Henriette Thaulow", 
                     "Hedlund, Magnus", "Ito, Shu" };

// Get the first string in the array that is longer
// than 20 characters, or the default value for type
// string (null) if none exists.
string firstLongName =
    names.AsQueryable().FirstOrDefault(name => name.Length > 20);

Console.WriteLine("The first long name is '{0}'.", firstLongName);

// Get the first string in the array that is longer
// than 30 characters, or the default value for type
// string (null) if none exists.
string firstVeryLongName =
    names.AsQueryable().FirstOrDefault(name => name.Length > 30);

Console.WriteLine(
    "There is {0} name that is longer than 30 characters.",
    string.IsNullOrEmpty(firstVeryLongName) ? "NOT a" : "a");

/*
    This code produces the following output:

    The first long name is 'Andersen, Henriette Thaulow'.
    There is NOT a name that is longer than 30 characters.
*/

Dim names() As String = {"Hartono, Tommy", "Adams, Terry", _
                     "Andersen, Henriette Thaulow", _
                     "Hedlund, Magnus", "Ito, Shu"}

' Get the first string in the array that is longer
' than 20 characters, or the default value for type
' string (null) if none exists.
Dim firstLongName As String = _
            names.AsQueryable().FirstOrDefault(Function(name) name.Length > 20)

MsgBox(String.Format("The first long name is '{0}'.", firstLongName))

' Get the first string in the array that is longer
' than 30 characters, or the default value for type
' string (null) if none exists.
Dim firstVeryLongName As String = _
    names.AsQueryable().FirstOrDefault(Function(name) name.Length > 30)

MsgBox(String.Format( _
    "There is {0} name that is longer than 30 characters.", _
    IIf(String.IsNullOrEmpty(firstVeryLongName), "NOT a", "a")))

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

注釈

このメソッドには、型引数が Func<T,TResult> 型の1つである Expression<TDelegate> 型のパラメーターが少なくとも1つ含まれています。This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T,TResult> types. これらのパラメーターでは、ラムダ式を渡すことができ、Expression<TDelegate>にコンパイルされます。For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.

FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) メソッドは、構築されたジェネリックメソッドとしての呼び出し FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 自体を表す MethodCallExpression を生成します。The FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) method generates a MethodCallExpression that represents calling FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) itself as a constructed generic method. 次に、source パラメーターの Provider プロパティによって表される IQueryProviderExecute<TResult>(Expression) メソッドに MethodCallExpression を渡します。It then passes the MethodCallExpression to the Execute<TResult>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) の呼び出しを表す式ツリーを実行した結果として発生するクエリ動作は、source パラメーターの型の実装によって異なります。The query behavior that occurs as a result of executing an expression tree that represents calling FirstOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) depends on the implementation of the type of the source parameter. 期待される動作は、predicateの条件を満たす source の最初の要素、または条件を満たす要素がない場合は既定値を返すことです。The expected behavior is that it returns the first element in source that satisfies the condition in predicate, or a default value if no element satisfies the condition.

適用対象