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

定义

命名空间:

System.Collections.Generic

程序集:

netstandard.dll, System.Collections.dll

Source:

Dictionary.cs

获取与指定键关联的值。

public:
 virtual bool TryGetValue(TKey key, [Runtime::InteropServices::Out] TValue % value);

public bool TryGetValue(TKey key, out TValue value);

abstract member TryGetValue : 'Key * 'Value -> bool
override this.TryGetValue : 'Key * 'Value -> bool

Public Function TryGetValue (key As TKey, ByRef value As TValue) As Boolean

参数

key

TKey

要获取的值的键。

value

TValue

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

返回

Boolean

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

实现

TryGetValue(TKey, TValue) TryGetValue(TKey, TValue)

例外

ArgumentNullException

key 是 null。

示例

该示例演示如何使用 TryGetValue 该方法作为一种更有效的方法来检索经常尝试字典中键的程序中的值。 相反，该示例还演示了尝试检索不存在的键时属性（C# 中的索引器）如何 Item[] 引发异常。

此代码示例是为 Dictionary<TKey,TValue> 类提供的大型示例的一部分（openWith 此示例中使用的字典的名称）。

// 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.
match openWith.TryGetValue "tif" with
| true, value -> printfn $"For key = \"tif\", value = {value}."
| _ -> printfn "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
    printfn $"""For key = "tif", value = {openWith["tif"]}"""
with :? KeyNotFoundException ->
    printfn "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

注解

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

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

TryGetValue如果代码经常尝试访问不在字典中的密钥，请使用此方法。 使用此方法比捕获 KeyNotFoundException 属性引发 Item[] 的更高效。

此方法接近 O（1） 操作。

另请参阅

• ContainsKey(TKey)
• Item[TKey]