次の方法で共有


FileStream.WriteAsync メソッド

定義

オーバーロード

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

現在のストリームにバイト シーケンスを非同期に書き込み、書き込んだバイト数だけストリーム内の現在位置を進め、キャンセル要求を監視します。

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

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

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

ソース:
FileStream.cs
ソース:
FileStream.cs
ソース:
FileStream.cs

現在のストリームにバイト シーケンスを非同期に書き込み、書き込んだバイト数だけストリーム内の現在位置を進め、キャンセル要求を監視します。

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

パラメーター

buffer
Byte[]

データの書き込み元となるバッファー。

offset
Int32

ストリームへのバイトのコピーを開始する位置を示す buffer 内のバイト オフセット。インデックス番号は 0 から始まります。

count
Int32

書き込む最大バイト数。

cancellationToken
CancellationToken

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

戻り値

非同期の書き込み操作を表すタスク。

属性

例外

buffernullです。

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

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

ストリームは書き込みをサポートしません。

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

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

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

次の例は、ファイルに非同期的に書き込む方法を示しています。

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)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}
Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

注釈

WriteAsyncメソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費するファイル操作を実行できます。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示されるアプリで特に重要です。

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

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

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

こちらもご覧ください

適用対象

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

ソース:
FileStream.cs
ソース:
FileStream.cs
ソース:
FileStream.cs

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

public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

パラメーター

buffer
ReadOnlyMemory<Byte>

データを書き込む元のメモリの領域。

cancellationToken
CancellationToken

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

戻り値

非同期の書き込み操作を表すタスク。

例外

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

注釈

WriteAsyncメソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示されるアプリで特に重要です。

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

操作が完了する前に取り消された場合、返されるタスクには プロパティの値がTaskStatus.CanceledTask.Status含まれます。

適用対象