RandomAccess.ReadAsync 方法

定义

重载

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

从给定偏移量处的给定文件中读取字节序列。

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

从给定偏移量处的给定文件中读取字节序列。

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

Source:
RandomAccess.cs
Source:
RandomAccess.cs
Source:
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

返回

读入缓冲区的字节总数。 如果多个字节当前不可用,则此值可能小于缓冲区中分配的字节数;如果已到达文件末尾,则为零 (0) 。

例外

handlebuffersnull

handle 无效。

文件关闭。

文件不支持查找 (管道或套接字) 。

fileOffset 为负数。

handle 未打开进行阅读。

出现 I/O 错误。

取消令牌已取消。 此异常存储在返回的任务中。

注解

文件的位置不是高级的。

此方法将存储在任务中,它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中,则在等待任务时将引发该异常。 使用异常(如 ArgumentException)仍会同步引发。 有关存储的异常,请参阅 引发的 Read(SafeFileHandle, IReadOnlyList<Memory<Byte>>, Int64)异常。

适用于

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

Source:
RandomAccess.cs
Source:
RandomAccess.cs
Source:
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

返回

读入缓冲区中的总字节数。 如果当前没有可用的字节数,则此值可以小于缓冲区中分配的字节数;如果已到达文件的末尾,则为零 (0) 。

例外

handlenull

handle 无效。

文件关闭。

文件不支持查找 (管道或套接字) 。

fileOffset 为负数。

handle 未打开进行阅读。

出现 I/O 错误。

取消令牌已取消。 此异常存储在返回的任务中。

注解

文件的位置不是高级的。

适用于