System.IO.IsolatedStorage.IsolatedStorageFileStream.Read Method

Copies bytes from the current buffered System.IO.IsolatedStorage.IsolatedStorageFileStream object to an array.

Syntax

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

Parameters

buffer
The buffer to read.
offset
The offset in the buffer at which to begin writing.
count
The maximum number of bytes to read.

Returns

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 is reached.

Remarks

The buffer parameter can be an instance of the Buffer class, or an array of one of the following types: byte, sbyte, char, short, int, long, ushort, uint, ulong, float, or double. The offset parameter gives the offset of the byte in buffer at which to begin writing (index in the buffer), and the count parameter gives the maximum number of bytes that will be read from this stream. The returned value is the actual number of bytes read, or zero if the end of the stream is reached. If the read operation is successful, the current position of the stream is advanced by the number of bytes read. If an exception occurs, the current position of the stream is unchanged.

The IsolatedStorageFileStream.Read(Byte[], int, int) method treats the buffer parameter as a block of bytes, regardless of its actual type. Likewise, the offset and count parameters are always specified in bytes. For buffer parameters other than byte arrays, this means that an element index must be multiplied by the element size in bytes to form a correct value for offset or count.

The IsolatedStorageFileStream.Read(Byte[], int, int) method will return zero only if the end of the stream is reached. In all other cases, IsolatedStorageFileStream.Read(Byte[], int, int) always reads at least one byte from the stream before returning. If no data is available from the System.IO.IsolatedStorage.IsolatedStorageFileStream object upon a call to IsolatedStorageFileStream.Read(Byte[], int, int), the method will block until at least one byte of data can be returned.

Requirements

Namespace: System.IO.IsolatedStorage
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0
Since: .NET 2.0