CharEnumerator.Clone Method

public:
 virtual System::Object ^ Clone();

public object Clone();

abstract member Clone : unit -> obj
override this.Clone : unit -> obj

Public Function Clone () As Object

An Object that is a copy of the current CharEnumerator object.

The return value is a copy of this instance of CharEnumerator and its current state. This is useful for saving your state while iterating through a String object.

For example, suppose your application uses an original instance of CharEnumerator to iterate through each character in a String. When some unique character is encountered, your application pauses processing and invokes the Clone method. In effect, this saves the CharEnumerator object's index in the String.

Your application uses the clone to navigate to another part of the String to perform some auxiliary processing. The side-effect of this navigation is the clone loses track of the position where processing stopped. However, when the auxiliary processing is complete, your application discards the clone and uses the original CharEnumerator instance to resume working on the String where the original processing stopped.