SortedList<TKey,TValue>.TryGetValue(TKey, TValue) メソッド

  • リファレンス

定義

名前空間:
System.Collections.Generic
アセンブリ:
System.dll, System.Collections.dll
アセンブリ:
System.Collections.dll
アセンブリ:
System.dll
アセンブリ:
netstandard.dll
ソース:
SortedList.cs
ソース:
SortedList.cs
ソース:
SortedList.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 に格納されている場合は SortedList<TKey,TValue>。それ以外の場合は false。

実装

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

例外

ArgumentNullException

key が nullです。

例

この例では、 メソッドを使用 TryGetValue して、並べ替えられたリストにないキーを頻繁に試行するプログラムの値を取得する、より効率的な方法を示します。 これに対して、この例では、存在しないキーを Item[] 取得しようとしたときに プロパティ (C#のインデクサー) が例外をスローする方法も示しています。

このコード例は、SortedList<TKey,TValue> クラスのために提供されている大規模な例の一部です。

// When a program often has to try keys that turn out not to
// be in the list, 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 list, 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 list, 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

// When a program often has to try keys that turn out not to
// be in the list, TryGetValue can be a more efficient
// way to retrieve values.
match openWith.TryGetValue("tif") with
| true, value ->
    printfn "For key = \"tif\", value = {value}."
| false, _ ->
    printfn "Key = \"tif\" is not found."

// The indexer throws an exception if the requested key is
// not in the list.
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 list.
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 list.
Try
    Console.WriteLine("For key = ""tif"", value = {0}.", _
        openWith("tif"))
Catch 
    Console.WriteLine("Key = ""tif"" is not found.")
End Try

// The indexer throws an exception if the requested key is
// not in the list.
try
    printfn $"""For key = "tif", value = {openWith["tif"]}."""
with 
    | :? KeyNotFoundException ->
        printfn "Key = \"tif\" is not found."

注釈

このメソッドは、 メソッドと プロパティの機能をContainsKeyItem[]組み合わせたものです。

キーが見つからない場合、 value パラメーターは値型に適切な既定値を取得します。たとえば、整数型 TValueの場合は 0、ブール型の場合は 0、 falsenull 参照型の場合は 0 です。

このメソッドはバイナリ検索を実行します。したがって、このメソッドは O(log n) 操作であり n 、 は Countです。

適用対象

こちらもご覧ください