Export (0) Print
Expand All

StringEnumerator.Reset Method

Sets the enumerator to its initial position, which is before the first element in the collection.

[Visual Basic]
Public Sub Reset()
[C#]
public void Reset();
[C++]
public: void Reset();
[JScript]
public function Reset();

Exceptions

Exception Type Condition
InvalidOperationException The collection was modified after the enumerator was created.

Remarks

Reset moves the enumerator to the beginning of the collection, before the first element. After Reset, MoveNext must be called to advance the enumerator to the first element of the collection before reading the value of Current.

Example

[Visual Basic, C#, C++] The following code example demonstrates several of the properties and methods of StringEnumerator.

[Visual Basic] 
Imports System
Imports System.Collections.Specialized

Public Class SamplesStringEnumerator

   Public Shared Sub Main()

      ' Creates and initializes a StringCollection.
      Dim myCol As New StringCollection()
      Dim myArr() As [String] = {"red", "orange", "yellow", "green", "blue", "indigo", "violet"}
      myCol.AddRange(myArr)

      ' Enumerates the elements in the StringCollection.
      Dim myEnumerator As StringEnumerator = myCol.GetEnumerator()
      While myEnumerator.MoveNext()
         Console.WriteLine("{0}", myEnumerator.Current)
      End While
      Console.WriteLine()

      ' Resets the enumerator and displays the first element again.
      myEnumerator.Reset()
      If myEnumerator.MoveNext() Then
         Console.WriteLine("The first element is {0}.", myEnumerator.Current)
      End If 

   End Sub 'Main

End Class 'SamplesStringEnumerator 


'This code produces the following output.
'
'red
'orange
'yellow
'green
'blue
'indigo
'violet
'
'The first element is red.


[C#] 
using System;
using System.Collections.Specialized;

public class SamplesStringEnumerator  {

   public static void Main()  {

      // Creates and initializes a StringCollection.
      StringCollection myCol = new StringCollection();
      String[] myArr = new String[] { "red", "orange", "yellow", "green", "blue", "indigo", "violet" };
      myCol.AddRange( myArr );

      // Enumerates the elements in the StringCollection.
      StringEnumerator myEnumerator = myCol.GetEnumerator();
      while ( myEnumerator.MoveNext() )
         Console.WriteLine( "{0}", myEnumerator.Current );
      Console.WriteLine();

      // Resets the enumerator and displays the first element again.
      myEnumerator.Reset();
      if ( myEnumerator.MoveNext() )
         Console.WriteLine( "The first element is {0}.", myEnumerator.Current );

   }

}

/*
This code produces the following output.

red
orange
yellow
green
blue
indigo
violet

The first element is red.

*/

[C++] 
#using <mscorlib.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections::Specialized;

int main() {

   // Creates and initializes a StringCollection.
   StringCollection* myCol = new StringCollection();
   String* myArr[] = { S"red", S"orange", S"yellow", S"green", S"blue", S"indigo", S"violet" };
   myCol->AddRange(myArr);

   // Enumerates the elements in the StringCollection.
   StringEnumerator* myEnumerator = myCol->GetEnumerator();
   while (myEnumerator->MoveNext())
      Console::WriteLine(S"{0}", myEnumerator->Current);
   Console::WriteLine();

   // Resets the enumerator and displays the first element again.
   myEnumerator->Reset();
   if (myEnumerator->MoveNext())
      Console::WriteLine(S"The first element is {0}.", myEnumerator->Current);

}


/*
This code produces the following output.

red
orange
yellow
green
blue
indigo
violet

The first element is red.

*/

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

StringEnumerator Class | StringEnumerator Members | System.Collections.Specialized Namespace | MoveNext | Current | IEnumerator.Reset

Show:
© 2014 Microsoft