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

Definice

Obor názvů:

System.Collections.Generic

Sestavení:

System.Runtime.dll

Získá hodnotu přidruženou k zadanému klíči.

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

Parametry

key

TKey

Klíč, jehož hodnota se má získat.

value

TValue

Když tato metoda vrátí hodnotu přidruženou k zadanému klíči, pokud je nalezen klíč; v opačném případě výchozí hodnota pro typ parametru value . Tento parametr se předává neinicializovaný.

Návraty

Boolean

true pokud objekt, který implementuje IDictionary<TKey,TValue> , obsahuje prvek se zadaným klíčem, falsev opačném případě .

Výjimky

ArgumentNullException

key je null.

Příklady

Příklad ukazuje, jak použít metodu TryGetValue k načtení hodnot. Pokud program často zkouší hodnoty klíčů, které nejsou ve slovníku, TryGetValue může být metoda efektivnější než použití Item[] vlastnosti (indexer v jazyce C#), která při pokusu o načtení neexistujících klíčů vyvolá výjimky.

Tento kód je součástí většího příkladu, který lze zkompilovat a spustit. Viz třída 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", 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

Poznámky

Tato metoda kombinuje funkce ContainsKey metody a Item[] vlastnosti.

Pokud klíč není nalezen, value získá parametr odpovídající výchozí hodnotu pro typ TValue, například nula (0) pro celočíselné typy, false pro logické typy a null pro referenční typy.

Viz také

• ContainsKey(TKey)
• Item[TKey]