Reads characters from the underlying stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream.
Assembly: mscorlib (in mscorlib.dll)
Public Overridable Function Read As Integer
public virtual int Read()
public: virtual int Read()
abstract Read : unit -> int override Read : unit -> int
Return Value
Type: System.Int32The next character from the input stream, or -1 if no characters are currently available.
| Exception | Condition |
|---|---|
| IOException |
An I/O error occurs. |
| ObjectDisposedException |
The stream is closed. |
BinaryReader does not restore the file position after an unsuccessful read.
For a list of common I/O tasks, see Common I/O Tasks.
The following example shows how to read and write data using memory as a backing store. This example displays a list of invalid file path characters to the console. Although the code tries to display a list of all invalid file path characters, not all of the characters are within the displayable set of characters. Because the list of invalid characters can vary based on the system, output for this code may also vary.
Imports System Imports System.IO Public Class BinaryRW Shared Sub Main() Dim i As Integer = 0 Dim invalidPathChars() As Char = Path.InvalidPathChars Dim memStream As new MemoryStream() Dim binWriter As New BinaryWriter(memStream) ' Write to memory. binWriter.Write("Invalid file path characters are: ") For i = 0 To invalidPathChars.Length - 1 binWriter.Write(invalidPathChars(i)) Next i ' Create the reader using the same MemoryStream ' as used with the writer. Dim binReader As New BinaryReader(memStream) ' Set Position to the beginning of the stream. memStream.Position = 0 ' Read the data from memory and write it to the console. Console.Write(binReader.ReadString()) Dim memoryData( _ CInt(memStream.Length - memStream.Position) - 1) As Char For i = 0 To memoryData.Length - 1 memoryData(i) = Convert.ToChar(binReader.Read()) Next i Console.WriteLine(memoryData) End Sub End Class
using System; using System.IO; class BinaryRW { static void Main() { int i = 0; char[] invalidPathChars = Path.InvalidPathChars; MemoryStream memStream = new MemoryStream(); BinaryWriter binWriter = new BinaryWriter(memStream); // Write to memory. binWriter.Write("Invalid file path characters are: "); for(i = 0; i < invalidPathChars.Length; i++) { binWriter.Write(invalidPathChars[i]); } // Create the reader using the same MemoryStream // as used with the writer. BinaryReader binReader = new BinaryReader(memStream); // Set Position to the beginning of the stream. memStream.Position = 0; // Read the data from memory and write it to the console. Console.Write(binReader.ReadString()); char[] memoryData = new char[memStream.Length - memStream.Position]; for(i = 0; i < memoryData.Length; i++) { memoryData[i] = Convert.ToChar(binReader.Read()); } Console.WriteLine(memoryData); } }
using namespace System; using namespace System::IO; int main() { int i; array<Char>^invalidPathChars = Path::InvalidPathChars; MemoryStream^ memStream = gcnew MemoryStream; BinaryWriter^ binWriter = gcnew BinaryWriter( memStream ); // Write to memory. binWriter->Write( "Invalid file path characters are: " ); for ( i = 0; i < invalidPathChars->Length; i++ ) { binWriter->Write( invalidPathChars[ i ] ); } // Create the reader using the same MemoryStream // as used with the writer. BinaryReader^ binReader = gcnew BinaryReader( memStream ); // Set Position to the beginning of the stream. binReader->BaseStream->Position = 0; // Read the data from memory and write it to the console. Console::Write( binReader->ReadString() ); array<Char>^memoryData = gcnew array<Char>(memStream->Length - memStream->Position); for ( i = 0; i < memoryData->Length; i++ ) { memoryData[ i ] = Convert::ToChar( binReader->Read() ); } Console::WriteLine( memoryData ); }
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryWindows 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.