Read Method (Char[], Int32, Int32)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Reads a specified maximum of characters from the current stream into a buffer, beginning at the specified index.

Namespace:  System.IO
Assembly:  System.IO (in System.IO.dll)

public override int Read(
	char[] buffer,
	int index,
	int count
)

Parameters

buffer
Type: array<System..::..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
Type: System..::..Int32
The index of buffer at which to begin writing.
count
Type: System..::..Int32
The maximum number of characters to read.

Return Value

Type: System..::..Int32
The number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the count parameter, depending on whether the data is available within the stream.

This method returns an integer so that it can return 0 if the end of the stream has been reached.

When using the Read method, it is more efficient to use a buffer that is the same size as the internal buffer of the stream, where the internal buffer is set to your desired block size, and to always read less than the block size. If the size of the internal buffer was unspecified when the stream was constructed, its default size is 4 kilobytes (4096 bytes). If you manipulate the position of the underlying stream after reading data into the buffer, the position of the underlying stream might not match the position of the internal buffer.

This method returns after either the number of characters specified by the count parameter are read, or the end of the file is reached. ReadBlock is a blocking version of Read.

Show: