FileStream.ReadAsync メソッド

リファレンス

定義

名前空間:: System.IO

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

アセンブリ:: netstandard.dll

アセンブリ:: mscorlib.dll, System.IO.FileSystem.dll

アセンブリ:: System.IO.FileSystem.dll

アセンブリ:: mscorlib.dll

重要

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

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken)	バイトシーケンスの現在のファイルストリームからの読み取りと、メモリ領域への書き込みを非同期に行い、読み取られたバイト数だけファイルストリーム内の位置を進め、キャンセル要求を監視します。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	バイトシーケンスの現在のファイルストリームからの読み取りと、指定されたオフセットで開始されるバイト配列への書き込みを非同期に行い、読み取られたバイトの合計数だけファイルストリーム内の位置を進め、キャンセル要求を監視します。

ReadAsync(Memory<Byte>, CancellationToken)

ソース:: FileStream.cs

ソース:: FileStream.cs

ソース:: FileStream.cs

バイトシーケンスの現在のファイルストリームからの読み取りと、メモリ領域への書き込みを非同期に行い、読み取られたバイト数だけファイルストリーム内の位置を進め、キャンセル要求を監視します。

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer: Memory<Byte>

データを書き込むバッファー。

cancellationToken: CancellationToken

キャンセル要求を監視するためのトークン。既定値は None です。

戻り値

ValueTask<Int32>

非同期の読み取り操作を表すタスク。バッファーへ読み取られたバイトの合計数がラップされます。現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、ストリームの末尾に到達した場合は 0 になることがあります。

例外

OperationCanceledException

キャンセルトークンが取り消されました。この例外は、返されたタスクに格納されます。

例

次の例は、ファイルから非同期的に読み取る方法を示しています。

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

注釈

ReadAsyncメソッドを使用すると、メインスレッドをブロックすることなく、リソースを大量に消費するファイル操作を実行できます。このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x Store アプリまたはデスクトップアプリで特に重要です。非同期メソッドは、Visual Basic および C# のおよび await キーワードと組み合わせてasync使用されます。

プロパティを使用して、 CanRead 現在のインスタンスが読み取りをサポートしているかどうかを判断します。

操作が完了する前に取り消された場合、返されるタスクにはプロパティの値がTaskStatus.Canceled Status含まれます。ファイルへのハンドルが破棄された場合、返されるタスクにはプロパティに例外がObjectDisposedException Task.Exception含まれます。

適用対象

.NET 9 およびその他のバージョン

製品	バージョン
.NET	Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard	2.1

ReadAsync(Byte[], Int32, Int32, CancellationToken)

ソース:: FileStream.cs

ソース:: FileStream.cs

ソース:: FileStream.cs

バイトシーケンスの現在のファイルストリームからの読み取りと、指定されたオフセットで開始されるバイト配列への書き込みを非同期に行い、読み取られたバイトの合計数だけファイルストリーム内の位置を進め、キャンセル要求を監視します。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

パラメーター

buffer: Byte[]

データを書き込むバッファー。

offset: Int32

ストリームからのデータの書き込み開始位置を示す buffer 内のバイトオフセット。

count: Int32

読み取る最大バイト数。

cancellationToken: CancellationToken

キャンセル要求を監視するためのトークン。

戻り値

Task<Int32>

属性: ComVisibleAttribute

例外

ArgumentNullException

buffer が nullです。

ArgumentOutOfRangeException

offset または count が負の値です。

ArgumentException

offset と count の合計が、バッファーの長さよりも大きいです。

NotSupportedException

ストリームは読み取りをサポートしません。

ObjectDisposedException

ストリームは破棄されています。

InvalidOperationException

ストリームは、前の読み取り操作によって現在使用されています。

OperationCanceledException

キャンセルトークンが取り消されました。この例外は、返されたタスクに格納されます。

例

次の例は、ファイルから非同期的に読み取る方法を示しています。

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

注釈

プロパティを使用して、 CanRead 現在のインスタンスが読み取りをサポートしているかどうかを判断します。

操作が完了する前に取り消された場合、返されるタスクにはプロパティの値がTaskStatus.Canceled Task.Status含まれます。ファイルへのハンドルが破棄された場合、返されるタスクにはプロパティに例外がObjectDisposedException Task.Exception含まれます。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。などの ArgumentException使用例外は、引き続き同期的にスローされます。格納されている例外については、によって Read(Byte[], Int32, Int32)スローされる例外に関するページを参照してください。

こちらもご覧ください

キャンセル

適用対象

.NET 9 およびその他のバージョン

製品	バージョン
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

次の方法で共有

FileStream.ReadAsync メソッド

定義

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken)

パラメーター

戻り値

例外

例

注釈

適用対象

ReadAsync(Byte[], Int32, Int32, CancellationToken)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

その他のリソース