RandomAccess.ReadAsync メソッド

リファレンス

定義

名前空間:: System.IO

アセンブリ:: System.Runtime.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

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

指定されたオフセットにある特定のファイルからバイトシーケンスを読み取ります。

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

指定されたオフセットにある特定のファイルからバイトシーケンスを読み取ります。

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)