IDictionary<TKey,TValue>.TryGetValue(TKey, TValue) Metod

Definition

Namnområde:
System.Collections.Generic
Sammansättningar:
mscorlib.dll, System.Runtime.dll
Sammansättning:
mscorlib.dll
Sammansättning:
System.Runtime.dll
Sammansättning:
netstandard.dll

Hämtar värdet som är associerat med den angivna nyckeln.

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

Parametrar

key
TKey

Nyckeln vars värde ska hämtas.

value
TValue

När den här metoden returnerar, det värde som är associerat med den angivna nyckeln, om nyckeln hittas; annars standardvärdet för parametertypen value . Den här parametern skickas oinitierad.

Returer

Boolean

true om objektet som implementerar IDictionary<TKey,TValue> innehåller ett element med den angivna nyckeln, falseannars .

Undantag

ArgumentNullException

key är null.

Exempel

Exemplet visar hur du använder TryGetValue metoden för att hämta värden. Om ett program ofta försöker använda nyckelvärden som inte finns i en ordlista TryGetValue kan metoden vara effektivare än att använda Item[] egenskapen (indexeraren i C#), vilket utlöser undantag när du försöker hämta obefintliga nycklar.

Den här koden är en del av ett större exempel som kan kompileras och köras. Se även System.Collections.Generic.IDictionary<TKey,TValue>.

// 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 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

Kommentarer

Den här metoden kombinerar funktionerna i ContainsKey metoden och egenskapen Item[] .

Om nyckeln inte hittas hämtar parametern value lämpligt standardvärde för typen TValue, till exempel noll (0) för heltalstyper, false för booleska typer och null för referenstyper.

Gäller för

Se även