ReadBlockAsync Method
Collapse the table of content
Expand the table of content

StringReader.ReadBlockAsync Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

public override Task<int> ReadBlockAsync(
	char[] buffer,
	int index,
	int count


Type: 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.
Type: System.Int32
The position in buffer at which to begin writing.
Type: System.Int32
The maximum number of characters to read. If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Return Value

Type: System.Threading.Tasks.Task<Int32>
A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.


buffer is null.


index or count is negative.


The sum of index and count is larger than the buffer length.


The string reader has been disposed.


The reader is currently in use by a previous read operation.

The task does not complete until either the number of characters specified by the count parameter are read, or the end of the string has been reached.

Windows Phone OS

Supported in: 8.1, 8.0

© 2016 Microsoft