IDictionaryEnumerator.Key Property

Definition

Gets the key of the current dictionary entry.

public:
 property System::Object ^ Key { System::Object ^ get(); };
public object Key { get; }
member this.Key : obj
Public ReadOnly Property Key As Object

Property Value

The key of the current element of the enumeration.

Exceptions

The IDictionaryEnumerator is positioned before the first entry of the dictionary or after the last entry.

Remarks

Key is undefined under any of the following conditions:

  • The enumerator is positioned before the first element in the collection, immediately after the enumerator is created. MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of Key.

  • The last call to MoveNext returned false, which indicates the end of the collection.

  • The enumerator is invalidated due to changes made in the collection, such as adding, modifying, or deleting elements.

Key returns the same object until MoveNext is called. MoveNext sets Key to the key of the next element in enumeration.

Applies to

See also