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

Definición

Obtiene el valor asociado a la clave 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

Clave cuyo valor se va a obtener.The key whose value to get.

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.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 se pasa sin inicializar.This parameter is passed uninitialized.

Devoluciones

Es true si el objeto que implementa IDictionary<TKey,TValue> contiene un elemento con la clave especificada; en caso contrario, es false.true if the object that implements IDictionary<TKey,TValue> contains an element with the specified key; otherwise, false.

Excepciones

key es null.key is null.

Ejemplos

En el ejemplo se muestra cómo usar el método TryGetValue para recuperar valores.The example shows how to use the TryGetValue method to retrieve values. Si un programa intenta con frecuencia valores de clave que no están en un diccionario, el método TryGetValue puede ser más eficaz que utilizar la propiedad Item[TKey] (el indizador en C#), que produce excepciones al intentar recuperar claves no existentes.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.

Este código forma parte de un ejemplo más grande que se puede compilar y ejecutar.This code is part of a larger example that can be compiled and executed. Vea 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

Comentarios

Este método combina la funcionalidad del método ContainsKey y la propiedad Item[TKey].This method combines the functionality of the ContainsKey method and the Item[TKey] property.

Si no se encuentra la clave, el parámetro value 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.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.

Se aplica a

Consulte también: