This documentation is archived and is not being maintained.

CryptoStream.Read Method

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)

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

Parameters

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

ExceptionCondition
NotSupportedException

The CryptoStreamMode associated with 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

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

.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

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