StreamReader.ReadBlock Method

Definition

Overloads

ReadBlock(Span<Char>)
ReadBlock(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current stream and writes the data to a buffer, beginning at the specified index.

ReadBlock(Span<Char>)

public:
 override int ReadBlock(Span<char> buffer);
public override int ReadBlock (Span<char> buffer);
override this.ReadBlock : Span<char> -> int
Public Overrides Function ReadBlock (buffer As Span(Of Char)) As Integer

Parameters

buffer
Span<Char>

Returns

ReadBlock(Char[], Int32, Int32)

Reads a specified maximum number of characters from the current stream and writes the data to a buffer, beginning at the specified index.

public:
 override int ReadBlock(cli::array <char> ^ buffer, int index, int count);
public override int ReadBlock (char[] buffer, int index, int count);
override this.ReadBlock : char[] * int * int -> int
Public Overrides Function ReadBlock (buffer As Char(), index As Integer, count As Integer) As Integer

Parameters

buffer
Char[]

When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

The position in buffer at which to begin writing.

count
Int32

The maximum number of characters to read.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.

Exceptions

buffer is null.

The buffer length minus index is less than count.

index or count is negative.

An I/O error occurred.

Remarks

The position of the underlying stream is advanced by the number of characters that were read into buffer.

The method blocks until either count characters are read, or the end of the stream has been reached. This is a blocking version of Read.

Applies to