• Article

CryptoStream.Read Method

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

Reads a sequence of bytes from the current CryptoStream and advances the position within the stream by the number of bytes read.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

Syntax

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

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

Parameters

  • buffer
    Type: array<System.Byte[]
    An array of bytes. A maximum of count bytes are read from the current stream and stored in buffer.
  • offset
    Type: System.Int32
    The byte offset in buffer at which to begin storing the data read from the current stream.
  • count
    Type: System.Int32
    The maximum number of bytes to be read from the current stream.

Return Value

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

Exceptions

Exception Condition
NotSupportedException

The CryptoStreamMode associated with the current CryptoStream object does not match the underlying stream. For example, this exception is thrown when using Read with an underlying stream that is write-only.
ArgumentOutOfRangeException

The offset parameter is less than zero.

-or-

The count parameter is less than zero.
ArgumentException

The sum of the count and offset parameters is longer than the length of the buffer.

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: 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.