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

Definición

Espacio de nombres:

System.Collections.Generic

Ensamblado:

System.Runtime.dll

Obtiene el valor asociado a la clave especificada.

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

Clave cuyo valor se va a obtener.

value

TValue

Cuando este método devuelve el resultado, el valor asociado a la clave especificada, si se encuentra la clave; en caso contrario, el valor predeterminado para el tipo del parámetro value. Este parámetro se pasa sin inicializar.

Devoluciones

Boolean

Es true si el objeto que implementa IDictionary<TKey,TValue> contiene un elemento con la clave especificada; en caso contrario, es false.

Excepciones

ArgumentNullException

key es null.

Ejemplos

En el ejemplo se muestra cómo usar el TryGetValue método para recuperar valores. Si un programa intenta con frecuencia valores de clave que no están en un diccionario, el TryGetValue método puede ser más eficaz que usar la Item[] propiedad (el indexador en C#), que produce excepciones al intentar recuperar claves inexistentes.

Este código forma parte de un ejemplo más grande que se puede compilar y ejecutar. Vea 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

Comentarios

Este método combina la funcionalidad del ContainsKey método y la Item[] propiedad .

Si no se encuentra la clave, el value parámetro obtiene el valor predeterminado adecuado para el tipo TValue; por ejemplo, cero (0) para los tipos enteros, false para los tipos booleanos y null para los tipos de referencia.

Consulte también

• ContainsKey(TKey)
• Item[TKey]