RandomAccess.ReadAsync Метод

Определение

Пространство имен:

System.IO

Сборка:

System.Runtime.dll

Перегрузки

Имя	Описание
ReadAsync(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64, CancellationToken)	Считывает последовательность байтов из заданного смещения.
ReadAsync(SafeFileHandle, Memory<Byte>, Int64, CancellationToken)	Считывает последовательность байтов из заданного смещения.

ReadAsync(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64, CancellationToken)

Исходный код:

RandomAccess.cs

Считывает последовательность байтов из заданного смещения.

public static System.Threading.Tasks.ValueTask<long> ReadAsync(Microsoft.Win32.SafeHandles.SafeFileHandle handle, System.Collections.Generic.IReadOnlyList<Memory<byte>> buffers, long fileOffset, System.Threading.CancellationToken cancellationToken = default);

static member ReadAsync : Microsoft.Win32.SafeHandles.SafeFileHandle * System.Collections.Generic.IReadOnlyList<Memory<byte>> * int64 * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int64>

Public Shared Function ReadAsync (handle As SafeFileHandle, buffers As IReadOnlyList(Of Memory(Of Byte)), fileOffset As Long, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Long)

Параметры

handle

SafeFileHandle

Дескриптор файла.

buffers

IReadOnlyList<Memory<Byte>>

Список буферов памяти. При возврате этого метода содержимое этих буферов заменяется байтами, считываемыми из файла.

fileOffset

Int64

Позиция файла для чтения из.

cancellationToken

CancellationToken

Маркер для отслеживания запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

ValueTask<Int64>

Общее количество байтов, считываемых в буферы. Это может быть меньше, чем количество байтов, выделенных в буферах, если в данный момент не доступно много байтов или ноль (0), если достигнут конец файла.

Исключения

ArgumentNullException

handle или buffers есть null.

ArgumentException

handle недопустим.

ObjectDisposedException

Файл закрыт.

NotSupportedException

Файл не поддерживает поиск (канал или сокет).

ArgumentOutOfRangeException

fileOffset отрицательно.

UnauthorizedAccessException

handle не был открыт для чтения.

IOException

Произошла ошибка ввода-вывода.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Позиция файла не расширена.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых Read(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64).

ReadAsync(SafeFileHandle, Memory<Byte>, Int64, CancellationToken)

Исходный код:

RandomAccess.cs

Считывает последовательность байтов из заданного смещения.

public static System.Threading.Tasks.ValueTask<int> ReadAsync(Microsoft.Win32.SafeHandles.SafeFileHandle handle, Memory<byte> buffer, long fileOffset, System.Threading.CancellationToken cancellationToken = default);

static member ReadAsync : Microsoft.Win32.SafeHandles.SafeFileHandle * Memory<byte> * int64 * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Shared Function ReadAsync (handle As SafeFileHandle, buffer As Memory(Of Byte), fileOffset As Long, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Параметры

handle

SafeFileHandle

Дескриптор файла.

buffer

Memory<Byte>

Область памяти. При возврате этого метода содержимое этого региона заменяется байтами, считываемыми из файла.

fileOffset

Int64

Позиция файла для чтения из.

cancellationToken

CancellationToken

Маркер для отслеживания запросов на отмену. Значение по умолчанию — None.

Возвращаемое значение

ValueTask<Int32>

Общее количество байтов, считываемых в буфер. Это может быть меньше числа байтов, выделенных в буфере, если в данный момент не доступно много байтов или ноль (0), если достигнут конец файла.

Исключения

ArgumentNullException

handle равно null.

ArgumentException

handle недопустим.

ObjectDisposedException

Файл закрыт.

NotSupportedException

Файл не поддерживает поиск (канал или сокет).

ArgumentOutOfRangeException

fileOffset отрицательно.

UnauthorizedAccessException

handle не был открыт для чтения.

IOException

Произошла ошибка ввода-вывода.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Позиция файла не расширена.