• Article

FileStream.Read Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Reads a block of bytes from the stream and writes the data in a given buffer.

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

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Overrides Function Read ( _
    <OutAttribute> array As Byte(), _
    offset As Integer, _
    count As Integer _
) As Integer

[SecuritySafeCriticalAttribute]
public override int Read(
    byte[] array,
    int offset,
    int count
)

Parameters

  • array
    Type: array<System.Byte[]
    When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
  • offset
    Type: System.Int32
    The byte offset in array at which the read bytes will be placed.
  • count
    Type: System.Int32
    The maximum number of bytes to read.

Return Value

Type: System.Int32
The total number of bytes read into the buffer. This might be less than the number of bytes requested if that number of bytes are not currently available, or zero if the end of the stream is reached.

Exceptions

Exception Condition
ArgumentNullException

array is nulla null reference (Nothing in Visual Basic).
ArgumentOutOfRangeException

offset or count is negative.
NotSupportedException

The stream does not support reading.
IOException

An I/O error occurs.
ArgumentException

offset and count describe an invalid range in array.
ObjectDisposedException

Methods were called after the stream was closed.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.