StringReader Class

StringReader Class

 

Implements a TextReader that reads from a string.

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

System.Object
  System.MarshalByRefObject
    System.IO.TextReader
      System.IO.StringReader

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class StringReader : TextReader

NameDescription
System_CAPS_pubmethodStringReader(String)

Initializes a new instance of the StringReader class that reads from the specified string.

NameDescription
System_CAPS_pubmethodClose()

Closes the StringReader.(Overrides TextReader.Close().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the TextReader object.(Inherited from TextReader.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the StringReader and optionally releases the managed resources.(Overrides TextReader.Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodPeek()

Returns the next available character but does not consume it.(Overrides TextReader.Peek().)

System_CAPS_pubmethodRead()

Reads the next character from the input string and advances the character position by one character.(Overrides TextReader.Read().)

System_CAPS_pubmethodRead(Char[], Int32, Int32)

Reads a block of characters from the input string and advances the character position by count.(Overrides TextReader.Read(Char[], Int32, Int32).)

System_CAPS_pubmethodReadAsync(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index. (Overrides TextReader.ReadAsync(Char[], Int32, Int32).)

System_CAPS_pubmethodReadBlock(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current text reader and writes the data to a buffer, beginning at the specified index.(Inherited from TextReader.)

System_CAPS_pubmethodReadBlockAsync(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.(Overrides TextReader.ReadBlockAsync(Char[], Int32, Int32).)

System_CAPS_pubmethodReadLine()

Reads a line of characters from the current string and returns the data as a string.(Overrides TextReader.ReadLine().)

System_CAPS_pubmethodReadLineAsync()

Reads a line of characters asynchronously from the current string and returns the data as a string.(Overrides TextReader.ReadLineAsync().)

System_CAPS_pubmethodReadToEnd()

Reads all characters from the current position to the end of the string and returns them as a single string.(Overrides TextReader.ReadToEnd().)

System_CAPS_pubmethodReadToEndAsync()

Reads all characters from the current position to the end of the string asynchronously and returns them as a single string.(Overrides TextReader.ReadToEndAsync().)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

StringReader enables you to read a string synchronously or asynchronously. You can read a character at a time with the Read or the ReadAsync method, a line at a time using the ReadLine or the ReadLineAsync method and an entire string using the ReadToEnd or the ReadToEndAsync method.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

The following table lists examples of other typical or related I/O tasks.

To do this...

See the example in this topic...

Create a text file.

How to: Write Text to a File

Write to a text file.

How to: Write Text to a File

Read from a text file.

How to: Read Text from a File

Append text to a file.

How to: Open and Append to a Log File

File.AppendText

FileInfo.AppendText

Get the size of a file.

FileInfo.Length

Get the attributes of a file.

File.GetAttributes

Set the attributes of a file.

File.SetAttributes

Determine if a file exists.

File.Exists

Read from a binary file.

How to: Read and Write to a Newly Created Data File

Write to a binary file.

How to: Read and Write to a Newly Created Data File

The following example shows how to read an entire string asynchronously.

using System;
using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                string readText = await reader.ReadToEndAsync();
                Console.WriteLine(readText);
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft