FileStream.WriteAsync FileStream.WriteAsync FileStream.WriteAsync Method

定義

オーバーロード

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

現在のストリームにバイト シーケンスを非同期に書き込み、書き込んだバイト数だけストリーム内の現在位置を進め、キャンセル要求を監視します。Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

メモリ領域から現在のバッファー ストリームにバイト シーケンスを非同期に書き込み、書き込まれたバイト数だけこのファイル ストリーム内の現在位置を進め、キャンセル要求を監視します。Asynchronously writes a sequence of bytes from a memory region to the current file stream, advances the current position within this file stream by the number of bytes written, and monitors cancellation requests.

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

現在のストリームにバイト シーケンスを非同期に書き込み、書き込んだバイト数だけストリーム内の現在位置を進め、キャンセル要求を監視します。Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::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

パラメーター

buffer
Byte[]

データの書き込み元となるバッファー。The buffer to write data from.

offset
Int32 Int32 Int32

ストリームへのバイトのコピーを開始する位置を示す buffer 内のバイト オフセット。インデックス番号は 0 から始まります。The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32 Int32 Int32

書き込む最大バイト数。The maximum number of bytes to write.

cancellationToken
CancellationToken CancellationToken CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests.

戻り値

非同期の書き込み操作を表すタスク。A task that represents the asynchronous write operation.

例外

buffernullです。buffer is null.

offset または count が負の値です。offset or count is negative.

offsetcount の合計が、バッファーの長さよりも大きいです。The sum of offset and count is larger than the buffer length.

ストリームは書き込みをサポートしません。The stream does not support writing.

ストリームは破棄されています。The stream has been disposed.

ストリームは、前の書き込み操作によって現在使用されています。The stream is currently in use by a previous write operation.

ファイルに非同期に書き込む方法を次の例に示します。The following example shows how to write asynchronously to a file.

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を使用すると、メインスレッドをブロックせずに、リソースを集中的に使用するファイル操作を実行できます。The WriteAsync method enables you to perform resource-intensive file operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストアWindows 8.x Store app or デスクトップdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

現在のCanWriteインスタンスが書き込みをサポートしているかどうかを判断するには、プロパティを使用します。Use the CanWrite property to determine whether the current instance supports writing.

操作が完了前にキャンセルされた場合、返されたCanceledタスクにはStatusプロパティの値が含まれます。If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property. ファイルへのハンドルが破棄された場合、返されたObjectDisposedExceptionタスクにはExceptionプロパティの例外が含まれます。If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Exception property.

こちらもご覧ください

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

メモリ領域から現在のバッファー ストリームにバイト シーケンスを非同期に書き込み、書き込まれたバイト数だけこのファイル ストリーム内の現在位置を進め、キャンセル要求を監視します。Asynchronously writes a sequence of bytes from a memory region to the current file stream, advances the current position within this file stream by the number of bytes written, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = null);
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

パラメーター

buffer
ReadOnlyMemory<Byte>

データを書き込む元のメモリの領域。The region of memory to write data from.

cancellationToken
CancellationToken CancellationToken CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

非同期の書き込み操作を表すタスク。A task that represents the asynchronous write operation.

注釈

メソッドWriteAsyncを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The WriteAsync method lets you perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストアWindows 8.x Store app or デスクトップdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

現在のCanWriteインスタンスが書き込みをサポートしているかどうかを判断するには、プロパティを使用します。Use the CanWrite property to determine whether the current instance supports writing.

操作が完了前にキャンセルされた場合、返されたTaskStatus.CanceledタスクにはTask.Statusプロパティの値が含まれます。If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

適用対象