IDictionary.Remove メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IDictionary.Remove メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したキーを持つ要素を IDictionary から削除します。

名前空間: System.Collections.Generic
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Function Remove ( _
    key As TKey _
) As Boolean

Visual Basic (使用法)

Dim instance As IDictionary(Of
 TKey, TValue)
Dim key As TKey
Dim returnValue As Boolean

returnValue = instance.Remove(key)

bool Remove (
    TKey key
)

C++

bool Remove (
    TKey key
)

boolean Remove (
    TKey key
)

JScript

function Remove (
    key : TKey
) : boolean

パラメータ

key: 削除する要素のキー。

戻り値
要素が正常に削除された場合は true。それ以外の場合は false。このメソッドは、key が元の IDictionary に見つからなかった場合にも false を返します。

例外

例外の種類	条件
ArgumentNullException	key が null 参照 (Visual Basic では Nothing) です。
NotSupportedException	IDictionary は読み取り専用です。

解説

オブジェクトが等しいかどうかを判断する方法で実装が異なります。たとえば、List クラスでは Comparer.Default が使用されます。また、Dictionary クラスでは、IComparer 実装をキーの比較に使うかどうかをユーザーが指定できます。

使用例

Remove メソッドを使用してキー/値ペアをディクショナリから削除する方法を次のコード例に示します。

このコードは、コンパイルして実行することのできる例の一部です。詳細については、System.Collections.Generic.IDictionary のトピックを参照してください。

Visual Basic

' Use the Remove method to remove a key/value pair.
Console.WriteLine(vbLf + "Remove(""doc"")")
openWith.Remove("doc")

If Not openWith.ContainsKey("doc")
 Then
    Console.WriteLine("Key ""doc""
 is not found.")
End If

// Use the Remove method to remove a key/value pair.
Console.WriteLine("\nRemove(\"doc\")");
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
    Console.WriteLine("Key \"doc\" is not found.");
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
IDictionary ジェネリックインターフェイス
IDictionary メンバ
System.Collections.Generic 名前空間
ICollection.IsReadOnly プロパティ

IDictionary.Remove メソッド

指定したキーを持つ要素を IDictionary オブジェクトから削除します。

名前空間: System.Collections
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Sub Remove ( _
    key As Object _
)

Visual Basic (使用法)

Dim instance As IDictionary
Dim key As Object

instance.Remove(key)

void Remove (
    Object key
)

C++

void Remove (
    Object^ key
)

void Remove (
    Object key
)

JScript

function Remove (
    key : Object
)

パラメータ

key: 削除する要素のキー。

例外

例外の種類

条件

ArgumentNullException

key が null 参照 (Visual Basic では Nothing) です。

NotSupportedException

IDictionary が読み取り専用です。

または

IDictionary が固定サイズです。

解説

指定したキーを持つ要素が IDictionary オブジェクトに格納されていない場合、IDictionary は変更されません。例外はスローされません。

使用例

Remove メソッドを実装する方法を次のコード例に示します。このコード例は、IDictionary クラスのトピックで取り上げているコード例の一部です。

Visual Basic

Public Sub Remove(ByVal
 key As Object) Implements
 IDictionary.Remove
    If key = Nothing Then
        Throw New ArgumentNullException("key")
    End If
    ' Try to find the key in the DictionaryEntry array
    Dim index As Integer
    If TryGetIndexOfKey(key, index) Then

        ' If the key is found, slide all the items up.
        Array.Copy(items, index + 1, items, index, (ItemsInUse - index) - 1)
        ItemsInUse = ItemsInUse - 1
    Else

        ' If the key is not in the dictionary, just return. 
    End If
End Sub

public void Remove(object key)
{
    if (key == null) throw new
 ArgumentNullException("key");
    // Try to find the key in the DictionaryEntry array
    Int32 index;
    if (TryGetIndexOfKey(key, out index))
    {
        // If the key is found, slide all the items up.
        Array.Copy(items, index + 1, items, index, ItemsInUse - index - 1);
        ItemsInUse--;
    } 
    else
    {
        // If the key is not in the dictionary, just return. 
    }
}

C++

public:
    virtual void Remove(Object^ key)
    {
        if (key == nullptr)
        {
            throw gcnew ArgumentNullException("key");
        }
        // Try to find the key in the DictionaryEntry array
        int index;
        if (TryGetIndexOfKey(key, &index))
        {
            // If the key is found, slide all the items down.
            Array::Copy(items, index + 1, items, index, itemsInUse -
                index - 1);
            itemsInUse--;
        }
        else
        {
            // If the key is not in the dictionary, just return.
            return;
        }
    }