RandomAccess.ReadAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

ReadAsync(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64, CancellationToken)	Lê uma sequência de bytes de determinado arquivo em determinado deslocamento.
ReadAsync(SafeFileHandle, Memory<Byte>, Int64, CancellationToken)	Lê uma sequência de bytes de determinado arquivo em determinado deslocamento.

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

Origem:

RandomAccess.cs

Lê uma sequência de bytes de determinado arquivo em determinado deslocamento.

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)

Parâmetros

handle

SafeFileHandle

O identificador do arquivo.

buffers

IReadOnlyList<Memory<Byte>>

Uma lista de buffers de memória. Quando esse método retorna, o conteúdo desses buffers é substituído pelos bytes lidos do arquivo.

fileOffset

Int64

A posição do arquivo do qual ler.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

ValueTask<Int64>

O número total de bytes lidos nos buffers. Isso pode ser menor do que o número de bytes alocados nos buffers se muitos bytes não estiverem disponíveis no momento ou zero (0) se o final do arquivo tiver sido atingido.

Exceções

ArgumentNullException

handle ou buffers é null.

ArgumentException

handle é inválido.

ObjectDisposedException

O arquivo está fechado.

NotSupportedException

O arquivo não dá suporte à busca (pipe ou soquete).

ArgumentOutOfRangeException

fileOffset é negativo.

UnauthorizedAccessException

handle não foi aberto para leitura.

IOException

Ocorreu um erro de E/S.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

A posição do arquivo não é avançada.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Read(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64).

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

Origem:

RandomAccess.cs

Lê uma sequência de bytes de determinado arquivo em determinado deslocamento.

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)

Parâmetros

handle

SafeFileHandle

O identificador do arquivo.

buffer

Memory<Byte>

Uma região da memória. Quando esse método retorna, o conteúdo dessa região é substituído pelos bytes lidos do arquivo.

fileOffset

Int64

A posição do arquivo do qual ler.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

ValueTask<Int32>

O número total de bytes lidos do buffer. Isso pode ser menor do que o número de bytes alocados no buffer se muitos bytes não estiverem disponíveis no momento ou zero (0) se o final do arquivo tiver sido atingido.

Exceções

ArgumentNullException

handle é null.

ArgumentException

handle é inválido.

ObjectDisposedException

O arquivo está fechado.

NotSupportedException

O arquivo não dá suporte à busca (pipe ou soquete).

ArgumentOutOfRangeException

fileOffset é negativo.

UnauthorizedAccessException

handle não foi aberto para leitura.

IOException

Ocorreu um erro de E/S.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

A posição do arquivo não é avançada.