IDictionary<TKey,TValue>.TryGetValue(TKey, TValue) 方法

定义

命名空间:
System.Collections.Generic
程序集:
mscorlib.dll, System.Runtime.dll
程序集:
mscorlib.dll
程序集:
System.Runtime.dll
程序集:
netstandard.dll

获取与指定键关联的值。

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

参数

key
TKey

要获取其值的键。

value
TValue

此方法返回时，如果找到该键，则与指定键关联的值;否则为参数类型的 value 默认值。 此参数未初始化传递。

返回

Boolean

true 如果实现 IDictionary<TKey,TValue> 的对象包含具有指定键的元素，则为 ;否则为 false。

例外

ArgumentNullException

key 是 null。

示例

该示例演示如何使用 TryGetValue 该方法检索值。 如果程序经常尝试键值不在字典中，则 TryGetValue 该方法比使用 Item[] 属性（C# 中的索引器）更高效，这会在尝试检索不存在的键时引发异常。

此代码是可以编译和执行的大型示例的一部分。 请参阅 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

注解

此方法结合了该方法和Item[]属性的功能ContainsKey。

如果未找到键，则 value 参数将获取类型 TValue的适当默认值;例如，整数类型的零（0）、 false 布尔类型以及 null 引用类型。

适用于

另请参阅