This documentation is archived and is not being maintained.

BinaryReader.Close Method

Closes the current reader and the underlying stream.

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

Public Overridable Sub Close
Dim instance As BinaryReader


This implementation of Close calls the Dispose method passing a true value.

Flushing the stream will not flush its underlying encoder unless you explicitly call Flush or Close. Setting AutoFlush to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.

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

Dim binReader As New 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. 
    Dim testArray As Byte() = {0,0,0,0}
    Dim count As Integer = binReader.Read(testArray, 0, 3)

    If count <> 0 Then 

        ' Reset the position in the stream to zero.
        binReader.BaseStream.Seek(0, SeekOrigin.Begin)

        aspRatio   = binReader.ReadSingle()
        lkupDir     = binReader.ReadString()
        saveTime  = binReader.ReadInt32()
        statusBar = binReader.ReadBoolean()
    End If 

' 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 ex As EndOfStreamException
    Console.WriteLine("{0} caught and ignored. " & _ 
        "Using default values.", ex.GetType().Name)
End Try

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0