Queryable.SingleOrDefault Méthode

Définition

Retourne un élément spécifique unique d'une séquence, ou une valeur par défaut si cet élément n'est pas trouvé.Returns a single, specific element of a sequence, or a default value if no such element is found.

Surcharges

SingleOrDefault<TSource>(IQueryable<TSource>)

Retourne l'élément unique d'une séquence ou une valeur par défaut. Cette méthode lève une exception si cette séquence contient plusieurs éléments.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>>)

Retourne l’élément unique d’une séquence ou une valeur par défaut si cette séquence ne contient pas d’élément respectant cette condition. Cette méthode lève une exception si cette séquence contient plusieurs éléments satisfaisant à cette condition.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>)

Retourne l'élément unique d'une séquence ou une valeur par défaut. Cette méthode lève une exception si cette séquence contient plusieurs éléments.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);
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

Paramètres de type

TSource

Le type des éléments de source.The type of the elements of source.

Paramètres

source
IQueryable<TSource>

IQueryable<T> duquel retourner le seul élément.An IQueryable<T> to return the single element of.

Retours

TSource

Élément unique de la séquence d’entrée ou default(TSource) si la séquence ne contient aucun élément.The single element of the input sequence, or default(TSource) if the sequence contains no elements.

Exceptions

source a la valeur null.source is null.

source a plusieurs éléments.source has more than one element.

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IQueryable<TSource>) pour sélectionner le seul élément d’un tableau.The following code example demonstrates how to use SingleOrDefault<TSource>(IQueryable<TSource>) to select the only element of an array. La deuxième requête montre que SingleOrDefault<TSource>(IQueryable<TSource>) retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément.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!

Parfois, la valeur de default(TSource) n’est pas la valeur par défaut que vous souhaitez utiliser si la collection ne contient aucun élément.Sometimes the value of default(TSource) is not the default value that you want to use if the collection contains no elements. Au lieu de vérifier le résultat de la valeur par défaut indésirable, puis de le modifier si nécessaire, vous pouvez utiliser la DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) méthode pour spécifier la valeur par défaut que vous souhaitez utiliser si la collection est vide.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. Ensuite, appelez Single<TSource>(IQueryable<TSource>) pour obtenir l’élément.Then, call Single<TSource>(IQueryable<TSource>) to obtain the element. L’exemple de code suivant utilise les deux techniques pour obtenir une valeur par défaut de 1 si une collection de numéros de page est vide.The following code example uses both techniques to obtain a default value of 1 if a collection of page numbers is empty. Étant donné que la valeur par défaut d’un entier est 0, ce qui n’est généralement pas un numéro de page valide, la valeur par défaut doit être spécifiée en tant que valeur 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. La première variable de résultat est vérifiée pour la valeur par défaut indésirable une fois la requête terminée.The first result variable is checked for the unwanted default value after the query is completed. La deuxième variable de résultat est obtenue en appelant DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) pour spécifier une valeur par défaut de 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

Remarques

La SingleOrDefault<TSource>(IQueryable<TSource>) méthode génère un MethodCallExpression qui représente l’appel de SingleOrDefault<TSource>(IQueryable<TSource>) lui-même comme une méthode générique construite.The SingleOrDefault<TSource>(IQueryable<TSource>) method generates a MethodCallExpression that represents calling SingleOrDefault<TSource>(IQueryable<TSource>) itself as a constructed generic method. Il passe ensuite MethodCallExpression à la Execute<TResult>(Expression) méthode de IQueryProvider représenté par la Provider propriété du source paramètre.It then passes the MethodCallExpression to the Execute<TResult>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

Le comportement de la requête qui se produit suite à l’exécution d’une arborescence d’expressions qui représente l’appel de SingleOrDefault<TSource>(IQueryable<TSource>) dépend de l’implémentation du type du source paramètre.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. Le comportement attendu est qu’il retourne le seul élément dans source , ou une valeur par défaut si source est vide.The expected behavior is that it returns the only element in source, or a default value if source is empty.

La SingleOrDefault méthode n’offre aucun moyen de spécifier une valeur par défaut.The SingleOrDefault method does not provide a way to specify a default value. Si vous souhaitez spécifier une valeur par défaut autre que default(TSource) , utilisez la DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) méthode comme décrit dans la section exemple.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.

S’applique à

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

Retourne l’élément unique d’une séquence ou une valeur par défaut si cette séquence ne contient pas d’élément respectant cette condition. Cette méthode lève une exception si cette séquence contient plusieurs éléments satisfaisant à cette condition.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);
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

Paramètres de type

TSource

Le type des éléments de source.The type of the elements of source.

Paramètres

source
IQueryable<TSource>

IQueryable<T> duquel retourner un seul élément.An IQueryable<T> to return a single element from.

predicate
Expression<Func<TSource,Boolean>>

Fonction permettant de tester un élément pour une condition.A function to test an element for a condition.

Retours

TSource

Élément unique de la séquence d’entrée qui satisfait la condition dans predicate, ou default(TSource) si aucun élément de ce type n’est trouvé.The single element of the input sequence that satisfies the condition in predicate, or default(TSource) if no such element is found.

Exceptions

source ou predicate est null.source or predicate is null.

Plusieurs éléments satisfont à la condition dans predicate.More than one element satisfies the condition in predicate.

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) pour sélectionner le seul élément d’un tableau qui satisfait à une condition.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. La deuxième requête montre que SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément qui satisfait à la condition.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!

Remarques

Cette méthode a au moins un paramètre de type Expression<TDelegate> dont l’argument de type est l’un des Func<T,TResult> types.This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T,TResult> types. Pour ces paramètres, vous pouvez passer une expression lambda et elle sera compilée dans un Expression<TDelegate> .For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.

La SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) méthode génère un MethodCallExpression qui représente l’appel de SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) lui-même comme une méthode générique construite.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. Il passe ensuite MethodCallExpression à la Execute<TResult>(Expression) méthode de IQueryProvider représenté par la Provider propriété du source paramètre.It then passes the MethodCallExpression to the Execute<TResult>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

Le comportement de la requête qui se produit suite à l’exécution d’une arborescence d’expressions qui représente l’appel de SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) dépend de l’implémentation du type du source paramètre.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. Le comportement attendu est qu’il retourne le seul élément dans source qui satisfait à la condition spécifiée par predicate , ou une valeur par défaut si aucun élément de ce type n’existe.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.

S’applique à