System.CharEnumerator.Current Property

Gets the currently referenced character in the string enumerated by this CharEnumerator object.

Syntax

public char Current { get; }

Value

The char in the string over which the current instance is positioned.

Exceptions

TypeReason
InvalidOperationExceptionThe current instance is positioned before the first element or after the last element of the string.

Remarks

The CharEnumerator class maintains an internal index to the enumerated string, and the CharEnumerator.Current property returns the character that is currently referenced by the index. This property should be invoked only when the index is valid; otherwise, an exception is thrown.

The index is always invalid for an empty string (""). The index is also invalid after the string.GetEnumerator or CharEnumerator.Reset method is called. After either of these methods is called, invoke the CharEnumerator.MoveNext method to adjust the index to the first character in the enumerated string. The index is valid whenever the CharEnumerator.MoveNext method returns true.

CharEnumerator.Current does not move the index, and consecutive calls to CharEnumerator.Current return the same character until CharEnumerator.MoveNext, CharEnumerator.Reset, or string.GetEnumerator is called.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0