FileStream.WriteAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

WriteAsync(Byte[], Int32, Int32, CancellationToken)	以非同步的方式將一連串的位元組寫入目前的資料流，由這個資料流中目前的位置前移寫入的位元組數目，並且監視取消要求。
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	以非同步方式將位元組序列從記憶體區域寫入目前的檔案資料流、依寫入的位元組數將此檔案資料流中目前位置往前移，並監視取消要求。

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

來源:

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);

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 中以零起始的位元組位移，要從其中開始將位元組複製至資料流。

count

Int32

寫入的最大位元組數。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。

傳回

Task

表示非同步寫入作業的工作。

例外狀況

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)
        {
            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使用屬性來判斷目前的實例是否支援寫入。

如果作業在完成之前取消，則傳回的工作會 Canceled 包含 屬性的值 Status 。 如果處置檔案的句柄，傳回的工作會在 ObjectDisposedException 屬性中包含例外狀況 Exception 。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 Write(Byte[], Int32, Int32)例外狀況。

另請參閱

• 取消

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

來源:

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。

傳回

ValueTask

表示非同步寫入作業的工作。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

方法 WriteAsync 可讓您執行需要大量資源的 I/O 作業，而不會封鎖主線程。 此效能考慮在耗時的串流作業可能會封鎖UI線程，並讓應用程式顯示為無法運作的應用程式中特別重要。

CanWrite使用屬性來判斷目前的實例是否支援寫入。

如果作業在完成之前取消，則傳回的工作會 TaskStatus.Canceled 包含 屬性的值 Task.Status 。