Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Dictionary<TKey,TValue>.TryGetValue(TKey, TValue) Method

Définition

Obtient la valeur associée à la clé spécifiée.Gets the value associated with the specified key.

public:
 virtual bool TryGetValue(TKey key, [Runtime::InteropServices::Out] TValue % value);
public bool TryGetValue (TKey key, out TValue value);
abstract member TryGetValue : 'Key * 'Value -> bool
override this.TryGetValue : 'Key * 'Value -> bool
Public Function TryGetValue (key As TKey, ByRef value As TValue) As Boolean

Paramètres

key
TKey TKey TKey TKey

Clé de la valeur à obtenir.The key of the value to get.

value
TValue TValue TValue TValue

Cette méthode retourne la valeur associée à la clé spécifiée, si la clé est trouvée ; sinon, retourne la valeur par défaut pour le type du paramètre value.When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. Ce paramètre est passé sans être initialisé.This parameter is passed uninitialized.

Retours

true si Dictionary<TKey,TValue> contient un élément correspondant à la clé spécifiée ; sinon, false.true if the Dictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

Implémente

Exceptions

Exemples

L’exemple montre comment utiliser la TryGetValue méthode comme un moyen plus efficace pour récupérer des valeurs dans un programme qui tente fréquemment des clés qui ne sont pas dans le dictionnaire.The example shows how to use the TryGetValue method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. Par opposition, l’exemple montre également comment la Item[TKey] propriété (l’indexeur dans C#) lève des exceptions lors de la tentative de récupération de clés inexistantes.For contrast, the example also shows how the Item[TKey] property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys.

Cet exemple de code fait partie d’un exemple plus complet fourni Dictionary<TKey,TValue> pour laopenWith classe (est le nom du dictionnaire utilisé dans cet exemple).This code example is part of a larger example provided for the Dictionary<TKey,TValue> class (openWith is the name of the Dictionary used in this example).

// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient
// way to retrieve values.
String^ value = "";
if (openWith->TryGetValue("tif", value))
{
    Console::WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console::WriteLine("Key = \"tif\" is not found.");
}
// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient 
// way to retrieve values.
string value = "";
if (openWith.TryGetValue("tif", out value))
{
    Console.WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console.WriteLine("Key = \"tif\" is not found.");
}
' When a program often has to try keys that turn out not to
' be in the dictionary, TryGetValue can be a more efficient 
' way to retrieve values.
Dim value As String = ""
If openWith.TryGetValue("tif", value) Then
    Console.WriteLine("For key = ""tif"", value = {0}.", value)
Else
    Console.WriteLine("Key = ""tif"" is not found.")
End If
// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console::WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException^)
{
    Console::WriteLine("Key = \"tif\" is not found.");
}
// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console.WriteLine("For key = \"tif\", value = {0}.", 
        openWith["tif"]);
}
catch (KeyNotFoundException)
{
    Console.WriteLine("Key = \"tif\" is not found.");
}
' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
    Console.WriteLine("For key = ""tif"", value = {0}.", _
        openWith("tif"))
Catch 
    Console.WriteLine("Key = ""tif"" is not found.")
End Try

Remarques

Cette méthode combine les fonctionnalités de la ContainsKey méthode et de Item[TKey] la propriété.This method combines the functionality of the ContainsKey method and the Item[TKey] property.

Si la clé est introuvable, le value paramètre obtient la valeur par défaut appropriée pour le TValuetype ; par exemple, 0 (zéro) pour les types false d’entiers, pour null les types booléens et pour les types référence.If the key is not found, then the value parameter gets the appropriate default value for the type TValue; for example, 0 (zero) for integer types, false for Boolean types, and null for reference types.

Utilisez la TryGetValue méthode si votre code tente souvent d’accéder à des clés qui ne sont pas dans le dictionnaire.Use the TryGetValue method if your code frequently attempts to access keys that are not in the dictionary. L’utilisation de cette méthode est plus efficace que l' KeyNotFoundException interception de Item[TKey] l’exception levée par la propriété.Using this method is more efficient than catching the KeyNotFoundException thrown by the Item[TKey] property.

Cette méthode s’approche d’une opération O (1).This method approaches an O(1) operation.

S’applique à

Voir aussi