This documentation is archived and is not being maintained.

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)

virtual String^ ReadString()

Return Value

Type: System::String
The string being read.


The end of the stream is reached.


The stream is closed.


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 = gcnew BinaryReader( File::Open( fileName, FileMode::Open ) );

            // If the file is not empty,
            // read the application settings.
            // First read 4 bytes into a buffer to
            // determine if the file is empty.
            array<Byte>^testArray = gcnew array<Byte>(3);
            int count = binReader->Read(testArray, 0, 3);
            if ( count != -1 )

               // Reset the position in the stream to zero.
               binReader->BaseStream->Seek(0, SeekOrigin::Begin);

               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 );

.NET Framework

Supported in: 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 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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