Queryable.SingleOrDefault メソッド

定義

シーケンスの 1 つの特定の要素を返します。そのような要素が見つからない場合は既定値を返します。

オーバーロード

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

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

SingleOrDefault<TSource>(IQueryable<TSource>)

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

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

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。

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

型パラメーター

TSource

source の要素の型。

パラメーター

source
IQueryable<TSource>

1 つの要素を返す IEnumerable<T>

defaultValue
TSource

シーケンスが空の場合に返される既定値。

戻り値

TSource

入力シーケンスの単一の要素。または defaultValue シーケンスに要素が含まれない場合は 。

例外

sourcenullです。

入力シーケンスに複数の要素が含まれています。

適用対象

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

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

型パラメーター

TSource

source の要素の型。

パラメーター

source
IQueryable<TSource>

1 つの要素を返す IEnumerable<T>

predicate
Expression<Func<TSource,Boolean>>

要素が条件を満たしているかどうかをテストする関数。

defaultValue
TSource

シーケンスが空の場合に返される既定値。

戻り値

TSource

条件を満たす入力シーケンスの単一要素。そのような defaultValue 要素が見つからない場合は 。

例外

source または predicatenull です。

predicate の条件を満たす要素が複数あります。

適用対象

SingleOrDefault<TSource>(IQueryable<TSource>)

シーケンスの唯一の要素を返します。シーケンスが空の場合、既定値を返します。シーケンス内に要素が複数ある場合、このメソッドは例外をスローします。

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);
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 の要素の型。

パラメーター

source
IQueryable<TSource>

1 つの要素を返す IQueryable<T>

戻り値

TSource

入力シーケンスの 1 つの要素。シーケンスに要素が含まれない場合は default (TSource)。

例外

sourcenullです。

source には複数の要素があります。

次のコード例では、 を使用 SingleOrDefault<TSource>(IQueryable<TSource>) して配列の唯一の要素を選択する方法を示します。 2 番目のクエリは、シーケンスに 1 つの要素が含まれていない場合に既定値を返す方法 SingleOrDefault<TSource>(IQueryable<TSource>) を示しています。

// 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) 値が使用する既定値ではない場合があります。 不要な既定値の結果を確認し、必要に応じて変更する代わりに、 メソッドを DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 使用して、コレクションが空の場合に使用する既定値を指定できます。 次に、 を呼び出 Single<TSource>(IQueryable<TSource>) して 要素を取得します。 次のコード例では、両方の手法を使用して、ページ番号のコレクションが空の場合に既定値 1 を取得します。 整数の既定値は 0 で、通常は有効なページ番号ではないので、既定値は代わりに 1 として指定する必要があります。 クエリが完了した後、最初の結果変数で不要な既定値がチェックされます。 2 番目の結果変数は、 を呼び出 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) して既定値の 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>) 表す を生成します。 次に、 パラメーターの MethodCallExpressionExecute<TResult>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。

呼び出し SingleOrDefault<TSource>(IQueryable<TSource>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 内 sourceの唯一の要素を返すか、 が空の場合 source は既定値を返します。

メソッドは SingleOrDefault 既定値を指定する方法を提供しません。 以外 default(TSource)の既定値を指定する場合は、「例」セクションの DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 説明に従って メソッドを使用します。

適用対象

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

指定された条件を満たすシーケンスの唯一の要素、またはそのような要素がない場合は既定値を返します。このメソッドは、複数の要素が条件を満たす場合に例外をスローします。

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);
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 の要素の型。

パラメーター

source
IQueryable<TSource>

1 つの要素を返す IQueryable<T>

predicate
Expression<Func<TSource,Boolean>>

要素が条件を満たしているかどうかをテストする関数。

戻り値

TSource

の条件predicatedefaultを満たす入力シーケンスの 1 つの要素。そのような要素が見つからない場合は (TSource) です。

例外

source または predicatenull です。

predicate の条件を満たす要素が複数あります。

次のコード例では、 を使用 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) して、条件を満たす配列の唯一の要素を選択する方法を示します。 2 番目のクエリは、シーケンスに SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 条件を満たす要素が 1 つだけ含まれていない場合に既定値を返す方法を示しています。

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 つである型のパラメーターが少なくとも 1 つ Func<T,TResult> 含まれています。 これらのパラメーターでは、ラムダ式を渡すことができます。これは に Expression<TDelegate>コンパイルされます。

メソッドは SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)MethodCallExpression 構築されたジェネリック メソッドとして自身を呼び出すことを SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 表す を生成します。 次に、 パラメーターの MethodCallExpressionExecute<TResult>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。

呼び出し SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 でpredicate指定された条件を満たす 唯一の source 要素を返すか、そのような要素が存在しない場合は既定値を返すということです。

適用対象