IDictionary<TKey,TValue>.TryGetValue(TKey, TValue) Método

Definição

Obtém o valor associado à chave especificada.Gets the value associated with the specified key.

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

Parâmetros

key
TKey

A chave cujo valor será obtido.The key whose value to get.

value
TValue

Quando esse método for retornado, o valor associado à chave especificada, se a chave for encontrada; caso contrário, o valor padrão do tipo do parâmetro value.When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. Este parâmetro é passado não inicializado.This parameter is passed uninitialized.

Retornos

true se o objeto que implementa o IDictionary<TKey,TValue> contiver um elemento com a chave especificada; caso contrário, false.true if the object that implements IDictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

Exceções

key é null.key is null.

Exemplos

O exemplo mostra como usar o método TryGetValue para recuperar valores.The example shows how to use the TryGetValue method to retrieve values. Se um programa freqüentemente tenta valores de chave que não estão em um dicionário, o método TryGetValue pode ser mais eficiente do que usar a propriedade Item[TKey] (o indexador em C#), que gera exceções ao tentar recuperar chaves inexistentes.If a program frequently tries key values that are not in a dictionary, the TryGetValue method can be more efficient than using the Item[TKey] property (the indexer in C#), which throws exceptions when attempting to retrieve nonexistent keys.

Esse código é parte de um exemplo maior que pode ser compilado e executado.This code is part of a larger example that can be compiled and executed. Consulte System.Collections.Generic.IDictionary<TKey,TValue>.See 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

Comentários

Esse método combina a funcionalidade do método ContainsKey e a propriedade Item[TKey].This method combines the functionality of the ContainsKey method and the Item[TKey] property.

Se a chave não for encontrada, o parâmetro value obterá o valor padrão apropriado para o tipo TValue; por exemplo, zero (0) para tipos inteiros, false para tipos booleanos e null para tipos de referência.If the key is not found, then the value parameter gets the appropriate default value for the type TValue; for example, zero (0) for integer types, false for Boolean types, and null for reference types.

Aplica-se a

Veja também