StreamReader.ReadBlockAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| ReadBlockAsync(Memory<Char>, CancellationToken) |
Считывает символы из текущего потока и записывает данные в буфер в асинхронном режиме. |
| ReadBlockAsync(Char[], Int32, Int32) |
Асинхронно считывает указанное максимальное количество символов из текущего потока и записывает данные в буфер, начиная с заданного индекса. |
ReadBlockAsync(Memory<Char>, CancellationToken)
- Исходный код:
- StreamReader.cs
- Исходный код:
- StreamReader.cs
- Исходный код:
- 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)Параметры
При возврате этого метода содержит указанный блок памяти, в котором символы заменены символами, считанными из текущего источника.
- cancellationToken
- CancellationToken
Токен для отслеживания запросов отмены. Значение по умолчанию — None.
Возвращаемое значение
Задача для значения, представляющая асинхронную операцию чтения. Тип параметра задачи для значения содержит общее число символов, считанных в буфер. Результирующее значение может быть меньше запрошенного числа символов, если число доступных в данный момент символов меньше запрошенного числа, или результат может быть равен 0 (нулю), если достигнут конец потока.
Исключения
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Применяется к
ReadBlockAsync(Char[], Int32, Int32)
- Исходный код:
- StreamReader.cs
- Исходный код:
- StreamReader.cs
- Исходный код:
- 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);[System.Runtime.InteropServices.ComVisible(false)]
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>[<System.Runtime.InteropServices.ComVisible(false)>]
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
Максимальное число считываемых символов. Если конец потока достигнут, прежде чем в буфер записано указанное количество символов, метод возвращает управление.
Возвращаемое значение
Задача, представляющая асинхронную операцию чтения. Значение параметра TResult содержит общее число символов (в байтах), считанных в буфер. Результирующее значение может быть меньше запрошенного числа символов, если число доступных в данный момент символов меньше запрошенного числа, или результат может быть равен 0 (нулю), если достигнут конец потока.
- Атрибуты
Исключения
buffer имеет значение null.
index или count является отрицательным значением.
Сумма index и count больше, чем длина буфера.
Поток был удален.
Модуль чтения в настоящее время используется предыдущей операцией чтения.
Комментарии
Задача не будет завершена до тех пор, пока не будет прочитано количество символов, указанное параметром count , или пока не будет достигнут конец потока.
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые ReadBlock(Char[], Int32, Int32).
