IsolatedStorageFileStream.Read Method

Definition

Overloads

Read(Byte[], Int32, Int32)

Copies bytes from the current buffered IsolatedStorageFileStream object to a byte array.

Read(Span<Byte>)

Copies bytes from the current buffered IsolatedStorageFileStream object to a byte span.

Read(Byte[], Int32, Int32)

Copies bytes from the current buffered IsolatedStorageFileStream object to a byte array.

public:
 override int Read(cli::array <System::Byte> ^ buffer, int offset, int count);
public override int Read (byte[] buffer, int offset, int count);
override this.Read : byte[] * int * int -> int
Public Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer

Parameters

buffer
Byte[]

The buffer to write the data into.

offset
Int32

The offset in the buffer at which to begin writing.

count
Int32

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, Int16, Int32, Int64, UInt16, UInt32, UInt64, Single, or Double.

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 Read 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 or the number of elements must be multiplied by the element size in bytes to form a correct value for offset or count.

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

Read(Span<Byte>)

Copies bytes from the current buffered IsolatedStorageFileStream object to a byte span.

public:
 override int Read(Span<System::Byte> buffer);
public override int Read (Span<byte> buffer);
override this.Read : Span<byte> -> int
Public Overrides Function Read (buffer As Span(Of Byte)) As Integer

Parameters

buffer
Span<Byte>

The buffer to write the data into.

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.

Applies to