RandomAccess.ReadAsync 方法

定義

命名空間:: System.IO

組件:: System.Runtime.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

名稱	Description
ReadAsync(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64, CancellationToken)	從指定偏移量讀取給定檔案的一串位元組。
ReadAsync(SafeFileHandle, Memory<Byte>, Int64, CancellationToken)	從指定偏移量讀取給定檔案的一串位元組。

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

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: 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

發生 I/O 錯誤。

OperationCanceledException

取消令牌也被取消了。此例外會儲存在回傳的任務中。

備註

檔案位置不前。

此方法在任務中儲存所有非使用例外，該方法的同步對應程式可拋出這些例外。如果回傳的任務中儲存了例外，該例外會在等待任務時拋出。使用例外錯誤，例如 ArgumentException，仍會同步拋出。關於儲存的例外，請參見由 Read(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64)拋出的例外。

適用於

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

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: RandomAccess.cs

來源:: 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)