Queryable.SingleOrDefault メソッド

ソース:

Queryable.cs

ソース:

Queryable.cs

ソース:

Queryable.cs

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

型パラメーター

パラメーター

戻り値

入力シーケンスの 1 つの要素。シーケンスに要素が含まれている場合は defaultValue。

例外

ソース:

Queryable.cs

ソース:

Queryable.cs

ソース:

Queryable.cs

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

型パラメーター

パラメーター

戻り値

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

例外

ソース:

Queryable.cs

ソース:

Queryable.cs

ソース:

Queryable.cs

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

型パラメーター

パラメーター

戻り値

入力シーケンスの単一の要素。シーケンスに要素が含 default(TSource) の場合。

例外

例

次のコード例では、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 番目の結果変数は、既定値の 1 を指定するために DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) を呼び出すことによって取得されます。

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>) メソッドは、構築されたジェネリック メソッドとしての呼び出し自体 SingleOrDefault<TSource>(IQueryable<TSource>) 表す MethodCallExpression を生成します。 次に、source パラメーターの Provider プロパティで表される IQueryProvider の Execute<TResult>(Expression) メソッドに MethodCallExpression を渡します。

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

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

ソース:

Queryable.cs

ソース:

Queryable.cs

ソース:

Queryable.cs

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

型パラメーター

パラメーター

戻り値

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

例外

例

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

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!

注釈

このメソッドには、型引数が Func<T,TResult> 型の 1 つである型 Expression<TDelegate> のパラメーターが少なくとも 1 つ含まれています。 これらのパラメーターの場合は、ラムダ式を渡すことができます。これは Expression<TDelegate>にコンパイルされます。

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

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