Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BinaryReader.ReadString Method

Reads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.

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

public virtual string ReadString ()
public String ReadString ()
public function ReadString () : String
Not applicable.

Return Value

The string being read.

Exception typeCondition

EndOfStreamException

The end of the stream is reached.

ObjectDisposedException

The stream is closed.

IOException

An I/O error occurs.

BinaryReader does not restore the file position after an unsuccessful read.

For a list of common I/O tasks, see Common I/O Tasks.

This code example is part of a larger example provided for the BinaryReader class.

BinaryReader binReader =
    new BinaryReader(File.Open(fileName, FileMode.Open));
try
{
    // If the file is not empty,
    // read the application settings.
    // Read 4 bytes into a buffer to
    // determine if the file is empty.
    byte[] testArray = new byte[3];
    int count = binReader.Read(testArray, 0, 3);

    if (count != 0)
    {
        aspectRatio   = binReader.ReadSingle();
        lookupDir     = binReader.ReadString();
        autoSaveTime  = binReader.ReadInt32();
        showStatusBar = binReader.ReadBoolean();
    }
}

// If the end of the stream is reached before reading
// the four data values, ignore the error and use the
// default settings for the remaining values.
catch(EndOfStreamException e)
{
    Console.WriteLine("{0} caught and ignored. " +
        "Using default values.", e.GetType().Name);
}
finally
{
    binReader.Close();
}

BinaryReader binReader =
    new BinaryReader(File.Open(fileName, FileMode.Open));
try {

    // If the file is not empty,
    // read the application settings.
    // Read 4 bytes into a buffer to
    // determine if the file is empty.
    ubyte[] testArray = new ubyte[3];
    int count = binReader.Read(testArray, 0, 3);
    if (count != 0)
    {
        aspectRatio = binReader.ReadSingle();
        lookupDir = binReader.ReadString();
        autoSaveTime = binReader.ReadInt32();
        showStatusBar = binReader.ReadBoolean();
    }
}

// If the end of the stream is reached before reading
// the four data values, ignore the error and use the
// default settings for the remaining values.
catch(EndOfStreamException e) {
    Console.WriteLine("{0} caught and ignored. "
        + "Using default values.", e.GetType().get_Name());
}
finally {
    binReader.Close();
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

Show:
© 2017 Microsoft