FileStream.WriteAsync FileStream.WriteAsync FileStream.WriteAsync Method

Definition

Überlädt

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

Schreibt beim Überschreiben in einer abgeleiteten Klasse eine Folge von Bytes asynchron in den aktuellen Stream und erhöht die aktuelle Position im Stream um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.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)

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

Schreibt beim Überschreiben in einer abgeleiteten Klasse eine Folge von Bytes asynchron in den aktuellen Stream und erhöht die aktuelle Position im Stream um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.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

Parameter

buffer
Byte[]

Der Puffer, aus dem Daten geschrieben werden sollen.The buffer to write data from.

offset
Int32 Int32 Int32

Der nullbasierte Byteoffset im buffer, ab dem Bytes in den Stream kopiert werden.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32 Int32 Int32

Die maximale Anzahl der zu schreibenden Bytes.The maximum number of bytes to write.

cancellationToken
CancellationToken CancellationToken CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests.

Gibt zurück

Eine Aufgabe, die den asynchronen Schreibvorgang darstellt.A task that represents the asynchronous write operation.

Ausnahmen

offset oder count ist ein negativer Wert.offset or count is negative.

Die Summe von offset und count ist größer als die Pufferlänge.The sum of offset and count is larger than the buffer length.

Der Stream unterstützt das Schreiben nicht.The stream does not support writing.

Der Stream wurde verworfen.The stream has been disposed.

Der Stream wird zurzeit von einem vorherigen Schreibvorgang verwendet.The stream is currently in use by a previous write operation.

Beispiele

Das folgende Beispiel zeigt, wie asynchron in eine Datei geschrieben wird.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

Hinweise

Die WriteAsync Methode können Sie ressourcenintensive Vorgänge ausführen, ohne den Hauptthread zu blockieren.The WriteAsync method enables you to perform resource-intensive file operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Die Async-Methoden werden verwendet, in Verbindung mit der async und await in Visual Basic und C#-Schlüsselwörter.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Verwenden der CanWrite Eigenschaft, um zu bestimmen, ob die aktuelle Instanz Schreibvorgänge unterstützt.Use the CanWrite property to determine whether the current instance supports writing.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen wurde, enthält die zurückgegebene Aufgabe der Canceled Wert für die Status Eigenschaft.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property. Wenn das Handle für die Datei verworfen wird, enthält die zurückgegebene Aufgabe der ObjectDisposedException Ausnahme in der Exception Eigenschaft.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Exception property.

Siehe auch

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

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

Parameter

Gibt zurück

Gilt für: