This topic has not yet been rated - Rate this topic

StringReader Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Implements a TextReader that reads from a string.

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

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

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

The StringReader type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library StringReader Initializes a new instance of the StringReader class that reads from the specified string.
Top
  Name Description
Public method Supported by the XNA Framework Close Closes the StringReader. (Overrides TextReader.Close().)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library Dispose() Releases all resources used by the TextReader object. (Inherited from TextReader.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Dispose(Boolean) Releases the unmanaged resources used by the StringReader and optionally releases the managed resources. (Overrides TextReader.Dispose(Boolean).)
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework Supported by Portable Class Library Peek Returns the next available character but does not consume it. (Overrides TextReader.Peek().)
Public method Supported by the XNA Framework Supported by Portable Class Library Read() Reads the next character from the input string and advances the character position by one character. (Overrides TextReader.Read().)
Public method Supported by the XNA Framework Supported by Portable Class Library Read(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).)
Public method ReadAsync 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).)
Public method Supported by the XNA Framework Supported by Portable Class Library ReadBlock 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.)
Public method ReadBlockAsync 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).)
Public method Supported by the XNA Framework Supported by Portable Class Library ReadLine Reads a line of characters from the current string and returns the data as a string. (Overrides TextReader.ReadLine().)
Public method ReadLineAsync Reads a line of characters asynchronously from the current string and returns the data as a string. (Overrides TextReader.ReadLineAsync().)
Public method Supported by the XNA Framework Supported by Portable Class Library ReadToEnd Reads all characters from the current position to the end of the string and returns them as a single string. (Overrides TextReader.ReadToEnd().)
Public method ReadToEndAsync Reads all characters from the current position to the end of the string asynchronously and returns them as a single string. (Overrides TextReader.ReadToEndAsync().)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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
//


.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)