StreamReader.ReadBlockAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

重载

ReadBlockAsync(Memory<Char>, CancellationToken)	从当前流中异步读取字符并将数据写入缓冲区。
ReadBlockAsync(Char[], Int32, Int32)	从当前流中异步读取指定的最大字符，并且从指定的索引位置开始将该数据写入缓冲区。

ReadBlockAsync(Memory<Char>, CancellationToken)

Source:

StreamReader.cs

从当前流中异步读取字符并将数据写入缓冲区。

public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadBlockAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

参数

buffer

Memory<Char>

此方法返回时，包含指定的字符内存块，这些字符由从当前源中读取的字符替换。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

ValueTask<Int32>

表示异步读取操作的值任务。 值任务的类型参数的值包含读入缓冲区的总字符数。 如果当前可用字符数少于所请求的字符数，则该结果值可小于所请求的字符数；如果已到达流结尾时，则为 0（零）。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

ReadBlockAsync(Char[], Int32, Int32)

Source:

StreamReader.cs

从当前流中异步读取指定的最大字符，并且从指定的索引位置开始将该数据写入缓冲区。

public:
 override System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);

override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadBlockAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

参数

buffer

Char[]

当此方法返回时，包含指定的字符数组，此数组中 index 和 (index + count - 1) 之间的值被从当前源中读取的字符所替换。

index

Int32

在 buffer 中开始写入的位置。

count

Int32

最多读取的字符数。 如果在将指定的字符数写入到缓冲区之前就已经达到流结尾，则将返回此方法。

返回

Task<Int32>

表示异步读取操作的任务。 TResult 参数的值包含读入缓冲区的总字符数。 如果当前可用字符数少于所请求的字符数，则该结果值可小于所请求的字符数；如果已到达流结尾时，则为 0（零）。

例外

ArgumentNullException

buffer 为 null。

ArgumentOutOfRangeException

index 或 count 为负数。

ArgumentException

index 和 count 的总和大于缓冲区长度。

ObjectDisposedException

已释放流。

InvalidOperationException

以前的读取操作当前正在使用读取器。

注解

在读取参数指定的 count 字符数或到达流的末尾之前，任务不会完成。

此方法存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 ReadBlock(Char[], Int32, Int32)异常。