Export (0) Print
Expand All

String.GetEnumerator Method

Retrieves an object that can iterate through the individual characters in this string.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

'Declaration
Public Function GetEnumerator As CharEnumerator
'Usage
Dim instance As String
Dim returnValue As CharEnumerator

returnValue = instance.GetEnumerator
public CharEnumerator GetEnumerator ()
public function GetEnumerator () : CharEnumerator

Return Value

A CharEnumerator object.

This method is required by programming languages that support the IEnumerator interface to iterate through members of a collection. For example, the Microsoft Visual Basic and C# programming languages' foreach statement invokes this method to return a CharEnumerator object that can provide read-only access to the characters in this instance of String.

The following code example uses the GetEnumerator method to display each System.Char in the input strings.

' Example for the String.GetEnumerator( ) method.
Imports System
Imports System.Collections
Imports Microsoft.VisualBasic

Module GetEnumerator
   
    Sub Main()
        Console.WriteLine( _
            "This example of String.GetEnumerator( ) " & _
            "generates the following output.")

        EnumerateAndDisplay("Test Case")
        EnumerateAndDisplay("Has" & vbTab & "two" & vbTab & "tabs")
        EnumerateAndDisplay("Two" & vbLf & "new" & vbLf & "lines")
    End Sub 'Main
       
    Sub EnumerateAndDisplay(Operand As String)

        Console.WriteLine( _
            vbCrLf & "The characters in the string ""{0}"" are:", Operand)
          
        Dim OperandEnum As IEnumerator = Operand.GetEnumerator()
        Dim CharCount As Integer = 0
          
        While OperandEnum.MoveNext()
            CharCount += 1
            Console.Write(" ""{0}"" ", OperandEnum.Current)
        End While

        Console.WriteLine(vbCrLf & " Character count: {0}", CharCount)

    End Sub 'EnumerateAndDisplay
End Module 'GetEnumerator

' This example of String.GetEnumerator( ) generates the following output.
' 
' The characters in the string "Test Case" are:
'  "T"  "e"  "s"  "t"  " "  "C"  "a"  "s"  "e"
'  Character count: 9
' 
' The characters in the string "Has       two     tabs" are:
'  "H"  "a"  "s"  "       "  "t"  "w"  "o"  "     "  "t"  "a"  "b"  "s"
'  Character count: 12
' 
' The characters in the string "Two
' new
' lines" are:
'  "T"  "w"  "o"  "
' "  "n"  "e"  "w"  "
' "  "l"  "i"  "n"  "e"  "s"
'  Character count: 13

// Example for the String.GetEnumerator( ) method.
import System.*;
import System.Collections.*;

class GetEnumerator
{
    public static void main(String[] args)
    {
        Console.WriteLine(("This example of String.GetEnumerator( ) "
            + "generates the following output."));
        EnumerateAndDisplay("Test Case");
        EnumerateAndDisplay("Has\ttwo\ttabs");
        EnumerateAndDisplay("Two\nnew\nlines");
    } //main

    static void EnumerateAndDisplay(String operand)
    {
        Console.WriteLine("\nThe characters in the string \"{0}\" are:", 
            operand);
        IEnumerator operandEnum = operand.GetEnumerator();
        int charCount = 0;
        while(operandEnum.MoveNext()) {
            charCount++;
            Console.Write(" '{0}' ", operandEnum.get_Current());
        }
        Console.WriteLine("\n Character count: {0}", 
            String.valueOf(charCount));
    } //EnumerateAndDisplay
} //GetEnumerator

/*
This example of String.GetEnumerator( ) generates the following output.

The characters in the string "Test Case" are:
 'T'  'e'  's'  't'  ' '  'C'  'a'  's'  'e'
 Character count: 9

The characters in the string "Has       two     tabs" are:
 'H'  'a'  's'  '       '  't'  'w'  'o'  '     '  't'  'a'  'b'  's'
 Character count: 12

The characters in the string "Two
new
lines" are:
 'T'  'w'  'o'  '
'  'n'  'e'  'w'  '
'  'l'  'i'  'n'  'e'  's'
 Character count: 13
*/

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft