Freigeben über


FileStream.WriteAsync Methode

Definition

Überlädt

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

Schreibt asynchron eine Bytesequenz in den aktuellen Datenstrom, wechselt die aktuelle Position innerhalb dieses Datenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Schreibt asynchron eine Bytesequenz aus einem Speicherbereich in den aktuellen Dateidatenstrom, wechselt die aktuelle Position innerhalb dieses Dateidatenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.

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

Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs

Schreibt asynchron eine Bytesequenz in den aktuellen Datenstrom, wechselt die aktuelle Position innerhalb dieses Datenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.

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

Parameter

buffer
Byte[]

Der Puffer zum Schreiben von Daten aus.

offset
Int32

Der nullbasierte Byte-Offset buffer , aus dem mit dem Kopieren von Bytes in den Datenstrom begonnen werden soll.

count
Int32

Die maximale Anzahl von Bytes, die geschrieben werden sollen.

cancellationToken
CancellationToken

Das Token, das auf Abbruchanforderungen überwacht werden soll.

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Attribute

Ausnahmen

buffer ist null.

offset oder count ist negativ.

Die Summe und offsetcount ist größer als die Pufferlänge.

Der Datenstrom unterstützt das Schreiben nicht.

Der Datenstrom wurde gelöscht.

Der Datenstrom wird derzeit von einem vorherigen Schreibvorgang verwendet.

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Beispiele

Das folgende Beispiel zeigt, wie Sie asynchron in eine Datei schreiben.

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

Hinweise

Mit der WriteAsync Methode können Sie ressourcenintensive Dateivorgänge ausführen, ohne den Hauptthread zu blockieren. Diese Leistungsüberlegung ist besonders wichtig bei Apps, bei denen ein zeitaufwendiger Streamvorgang den UI-Thread blockieren und ihre App so erscheinen lässt, als ob sie nicht funktioniert.

Verwenden Sie die CanWrite Eigenschaft, um zu bestimmen, ob die aktuelle Instanz das Schreiben unterstützt.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen wird, enthält der zurückgegebene Vorgang den Canceled Wert für die Status Eigenschaft. Wenn das Handle für die Datei verworfen wird, enthält die zurückgegebene Aufgabe die ObjectDisposedException Ausnahme in der Exception Eigenschaft.

Diese Methode speichert in der Aufgabe, die alle Nicht-Verwendungs-Ausnahmen zurückgibt, die das synchrone Gegenstück der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Verwendungsausnahmen, z. B. ArgumentException, werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie in den von Write(Byte[], Int32, Int32).

Weitere Informationen

Gilt für:

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs
Quelle:
FileStream.cs

Schreibt asynchron eine Bytesequenz aus einem Speicherbereich in den aktuellen Dateidatenstrom, wechselt die aktuelle Position innerhalb dieses Dateidatenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.

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

Parameter

buffer
ReadOnlyMemory<Byte>

Der Speicherbereich, aus dem Daten geschrieben werden sollen.

cancellationToken
CancellationToken

Das Token, das auf Abbruchanforderungen überwacht werden soll. Der Standardwert ist None.

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.

Ausnahmen

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Mit der WriteAsync Methode können Sie ressourcenintensive E/A-Vorgänge ausführen, ohne den Hauptthread zu blockieren. Diese Leistungsüberlegung ist besonders wichtig bei Apps, bei denen ein zeitaufwendiger Streamvorgang den UI-Thread blockieren und ihre App so erscheinen lässt, als ob sie nicht funktioniert.

Verwenden Sie die CanWrite Eigenschaft, um zu bestimmen, ob die aktuelle Instanz das Schreiben unterstützt.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen wird, enthält der zurückgegebene Vorgang den TaskStatus.Canceled Wert für die Task.Status Eigenschaft.

Gilt für: