OrderedDictionary.GetEnumerator メソッド

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

OrderedDictionary.GetEnumerator メソッド

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

OrderedDictionary コレクションを反復処理する IDictionaryEnumerator オブジェクトを返します。

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

Visual Basic (宣言)

Public Overridable Function
 GetEnumerator As IDictionaryEnumerator

Visual Basic (使用法)

Dim instance As OrderedDictionary
Dim returnValue As IDictionaryEnumerator

returnValue = instance.GetEnumerator

C#

public virtual IDictionaryEnumerator GetEnumerator ()

C++

public:
virtual IDictionaryEnumerator^ GetEnumerator ()

J#

public IDictionaryEnumerator GetEnumerator ()

JScript

public function GetEnumerator () : IDictionaryEnumerator

戻り値
OrderedDictionary コレクションの IDictionaryEnumerator オブジェクト。

解説

C# 言語の foreach ステートメント (Visual Basic の場合は for each) を使用することで列挙子の複雑さを回避できます。したがって、列挙子を直接操作するのではなく、foreach の使用をお勧めします。

列挙子を使用すると、コレクション内のデータを読み取ることができますが、基になるコレクションを変更することはできません。

最初に、列挙子はコレクションの最初の要素の前に配置されます。

コレクションが変更されない限り、列挙子は有効なままです。要素の追加、変更、削除などの変更がコレクションに対して実行されると、列挙子は回復不可能な無効状態になり、動作は未定義になります。

列挙子には、コレクションへの排他的なアクセスがありません。したがって、コレクションの列挙処理は、本質的にはスレッド セーフな処理ではありません。すべての列挙処理が終わるまでコレクションをロックすることにより、列挙処理でのスレッド セーフを確保できます。コレクションに対し複数のスレッドがアクセスして読み取りや書き込みを行うことができるようにするには、独自に同期化を実装する必要があります。

このメソッドは O(1) 操作です。

使用例

GetEnumerator メソッドを使用して OrderedDictionary コレクションの内容をコンソールに出力する方法を次のコード例に示します。この例では、GetEnumerator メソッドを使用して、内容を表示するメソッドに渡される IDictionaryEnumerator オブジェクトを取得します。このコードは、OrderedDictionary で参照できるコード例の一部です。

Visual Basic

' Clear the OrderedDictionary and add new values
myOrderedDictionary.Clear()
myOrderedDictionary.Add("newKey1", "newValue1")
myOrderedDictionary.Add("newKey2", "newValue2")
myOrderedDictionary.Add("newKey3", "newValue3")

' Display the contents of the "new" Dictionary Imports an
 enumerator
Dim myEnumerator As IDictionaryEnumerator =
 _
    myOrderedDictionary.GetEnumerator()

Console.WriteLine( _
    "{0}Displaying the entries of a 'new' OrderedDictionary.",
 _
    Environment.NewLine)

DisplayEnumerator(myEnumerator)

C#

// Clear the OrderedDictionary and add new values
myOrderedDictionary.Clear();
myOrderedDictionary.Add("newKey1", "newValue1");
myOrderedDictionary.Add("newKey2", "newValue2");
myOrderedDictionary.Add("newKey3", "newValue3");

// Display the contents of the "new" Dictionary using an enumerator
IDictionaryEnumerator myEnumerator =
    myOrderedDictionary.GetEnumerator();

Console.WriteLine(
    "{0}Displaying the entries of a \"new\" OrderedDictionary."
,
    Environment.NewLine);

DisplayEnumerator(myEnumerator);

Visual Basic

' Displays the contents of the OrderedDictionary using its enumerator
Public Shared Sub DisplayEnumerator(
 _
    ByVal myEnumerator As IDictionaryEnumerator)

    Console.WriteLine("   KEY                       VALUE")
    While myEnumerator.MoveNext()
        Console.WriteLine("   {0,-25} {1}", _
            myEnumerator.Key, myEnumerator.Value)
    End While
End Sub

C#

// Displays the contents of the OrderedDictionary using its enumerator
public static void DisplayEnumerator(IDictionaryEnumerator
 myEnumerator)
{
    Console.WriteLine("   KEY                       VALUE");
    while (myEnumerator.MoveNext())
    {
        Console.WriteLine("   {0,-25} {1}",
            myEnumerator.Key, myEnumerator.Value);
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
OrderedDictionary クラス
OrderedDictionary メンバ
System.Collections.Specialized 名前空間