Queryable.SingleOrDefault Queryable.SingleOrDefault Queryable.SingleOrDefault Queryable.SingleOrDefault Method

定義

シーケンスの 1 つの特定の要素を返します。そのような要素が見つからない場合は既定値を返します。Returns a single, specific element of a sequence, or a default value if no such element is found.

オーバーロード

SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>)

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.

SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>) SingleOrDefault<TSource>(IQueryable<TSource>)

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.

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

型パラメーター

TSource

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

パラメーター

source
IQueryable<TSource>

1 つの要素を返す IQueryable<T>An IQueryable<T> to return the single element of.

戻り値

TSource TSource TSource TSource

入力シーケンスの唯一の要素、または、シーケンスに要素が含まれない場合は default(TSource)。The single element of the input sequence, or default(TSource) if the sequence contains no elements.

例外

source には複数の要素があります。source has more than one element.

次のコード例は、を使用SingleOrDefault<TSource>(IQueryable<TSource>)して配列の唯一の要素を選択する方法を示しています。The following code example demonstrates how to use SingleOrDefault<TSource>(IQueryable<TSource>) to select the only element of an array. 2番目のクエリSingleOrDefault<TSource>(IQueryable<TSource>)では、シーケンスに要素が1つだけ含まれていない場合に、が既定値を返すことを示しています。The second query demonstrates that SingleOrDefault<TSource>(IQueryable<TSource>) returns a default value when the sequence does not contain exactly one element.

// Create two arrays. The second is empty.
string[] fruits1 = { "orange" };
string[] fruits2 = { };

// Get the only item in the first array, or else
// the default value for type string (null).
string fruit1 = fruits1.AsQueryable().SingleOrDefault();
Console.WriteLine("First Query: " + fruit1);

// Get the only item in the second array, or else
// the default value for type string (null). 
string fruit2 = fruits2.AsQueryable().SingleOrDefault();
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: orange
    Second Query: No such string!
*/

' Create two arrays. The second is empty.
Dim fruits1() As String = {"orange"}
Dim fruits2() As String = {}

' Get the only item in the first array, or else
' the default value for type string (null).
Dim fruit1 As String = fruits1.AsQueryable().SingleOrDefault()
MsgBox("First Query: " + fruit1)

' Get the only item in the second array, or else
' the default value for type string (null). 
Dim fruit2 As String = fruits2.AsQueryable().SingleOrDefault()
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: orange
' Second Query: No such string!

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. 次に、 Single<TSource>(IQueryable<TSource>)を呼び出して要素を取得します。Then, call Single<TSource>(IQueryable<TSource>) to obtain the element. 次のコード例では、ページ番号のコレクションが空の場合に、両方の手法を使用して既定値1を取得します。The following code example uses both techniques to obtain a default value of 1 if a collection of page numbers is empty. 整数の既定値は0であるため、通常は有効なページ番号ではありません。そのため、既定値は1として指定する必要があります。Because the default value for an integer is 0, which is not usually a valid page number, 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.

int[] pageNumbers = { };

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

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

/*
 This code produces the following output:

 The value of the pageNumber1 variable is 1
 The value of the pageNumber2 variable is 1
*/

Dim pageNumbers() As Integer = {}

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

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

' This code produces the following output:

' The value of the pageNumber1 variable is 1
' The value of the pageNumber2 variable is 1

注釈

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

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

SingleOrDefaultメソッドには、既定値を指定する方法は用意されていません。The SingleOrDefault method does not provide a way to specify a default value. 以外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.

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate);
public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate);
static member SingleOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> -> 'Source
<Extension()>
Public Function SingleOrDefault(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>

1 つの要素を返す IQueryable<T>An IQueryable<T> to return a single element from.

predicate
Expression<Func<TSource,Boolean>>

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

戻り値

TSource TSource TSource TSource

predicate の条件を満たす入力シーケンスの唯一要素、または、そのような要素が見つからない場合は default(TSource)。The single element of the input sequence that satisfies the condition in predicate, or default(TSource) if no such element is found.

例外

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

predicate の条件を満たす要素が複数あります。More than one element satisfies the condition in predicate.

次のコード例は、を使用SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)して、条件を満たす配列の唯一の要素を選択する方法を示しています。The following code example demonstrates how to use SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) to select the only element of an array that satisfies a condition. 2番目のクエリSingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)は、シーケンスに条件を満たす要素が1つだけ含まれていない場合に、が既定値を返すことを示しています。The second query demonstrates that SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) returns a default value when the sequence does not contain exactly one element that satisfies the condition.

string[] fruits = { "apple", "banana", "mango", 
                      "orange", "passionfruit", "grape" };

// Get the single string in the array whose length is greater
// than 10, or else the default value for type string (null).
string fruit1 =
    fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 10);
Console.WriteLine("First Query: " + fruit1);

// Get the single string in the array whose length is greater
// than 15, or else the default value for type string (null).
string fruit2 =
   fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 15);
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: passionfruit
    Second Query: No such string!
*/

Dim fruits() As String = _
    {"apple", "banana", "mango", "orange", "passionfruit", "grape"}

' Get the single string in the array whose length is greater
' than 10, or else the default value for type string (null).
Dim fruit1 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 10)
' Display the result.
MsgBox("First Query: " & fruit1)

' Get the single string in the array whose length is greater
' than 15, or else the default value for type string (null).
Dim fruit2 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 15)
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: passionfruit
' Second Query: No such string!

注釈

このメソッドには、型引数が型Expression<TDelegate>の1つ以上の型のFunc<T,TResult>パラメーターが少なくとも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>.

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

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

適用対象