RandomAccess.ReadAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Przeciążenia

Nazwisko	Opis
ReadAsync(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64, CancellationToken)	Odczytuje sekwencję bajtów z danego pliku z danego przesunięcia.
ReadAsync(SafeFileHandle, Memory<Byte>, Int64, CancellationToken)	Odczytuje sekwencję bajtów z danego pliku z danego przesunięcia.

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

Źródło:

RandomAccess.cs

Odczytuje sekwencję bajtów z danego pliku z danego przesunięcia.

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)

Parametry

handle

SafeFileHandle

Dojście do pliku.

buffers

IReadOnlyList<Memory<Byte>>

Lista buforów pamięci. Gdy ta metoda zwraca, zawartość tych buforów jest zastępowana przez bajty odczytane z pliku.

fileOffset

Int64

Położenie pliku do odczytania. W .NET 11 lub nowszych wersjach ten parametr jest ignorowany dla plików, które nie obsługują wyszukiwania, takich jak potoki, gniazda i urządzenia znakowe. Wartość musi być nieujemna nawet wtedy, gdy jest ignorowana.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

ValueTask<Int64>

Całkowita liczba bajtów odczytanych do buforów. Może to być mniejsza niż liczba bajtów przydzielonych w buforach, jeśli liczba bajtów nie jest obecnie dostępna lub zero (0), jeśli osiągnięto koniec pliku.

Wyjątki

ArgumentNullException

handle lub buffers ma wartość null.

ArgumentException

handle jest nieprawidłowy.

ObjectDisposedException

Plik jest zamknięty.

NotSupportedException

W .NET 10 i starszych wersjach plik nie obsługuje wyszukiwania (na przykład potoku lub gniazda).

ArgumentOutOfRangeException

fileOffset jest ujemna.

UnauthorizedAccessException

handle nie został otwarty do czytania.

IOException

Wystąpił błąd we/wy.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

W przypadku plików, które obsługują wyszukiwanie, pozycja pliku nie jest zaawansowana.

Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. Aby uzyskać informacje o przechowywanych wyjątkach, zobacz wyjątki zgłaszane przez program Read(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64).

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

Źródło:

RandomAccess.cs

Odczytuje sekwencję bajtów z danego pliku z danego przesunięcia.

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)

Parametry

handle

SafeFileHandle

Dojście do pliku.

buffer

Memory<Byte>

Region pamięci. Gdy ta metoda zwraca, zawartość tego regionu jest zastępowana przez bajty odczytane z pliku.

fileOffset

Int64

Położenie pliku do odczytania. W .NET 11 lub nowszych wersjach ten parametr jest ignorowany dla plików, które nie obsługują wyszukiwania, takich jak potoki, gniazda i urządzenia znakowe. Wartość musi być nieujemna nawet wtedy, gdy jest ignorowana.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

ValueTask<Int32>

Całkowita liczba bajtów odczytanych do buforu. Może to być mniej niż liczba bajtów przydzielonych w buforze, jeśli liczba bajtów nie jest obecnie dostępna lub zero (0), jeśli osiągnięto koniec pliku.

Wyjątki

ArgumentNullException

Parametr handle ma wartość null.

ArgumentException

handle jest nieprawidłowy.

ObjectDisposedException

Plik jest zamknięty.

NotSupportedException

W .NET 10 i starszych wersjach plik nie obsługuje wyszukiwania (na przykład potoku lub gniazda).

ArgumentOutOfRangeException

fileOffset jest ujemna.

UnauthorizedAccessException

handle nie został otwarty do czytania.

IOException

Wystąpił błąd we/wy.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

W przypadku plików, które obsługują wyszukiwanie, pozycja pliku nie jest zaawansowana.