FileStream.WriteAsync Metoda

  • Reference

Definice

Obor názvů:
System.IO
Sestavení:
mscorlib.dll, System.IO.FileSystem.dll
Sestavení:
System.Runtime.dll
Sestavení:
System.IO.FileSystem.dll
Sestavení:
mscorlib.dll
Sestavení:
netstandard.dll

Přetížení

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

Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Asynchronně zapíše sekvenci bajtů z oblasti paměti do aktuálního datového proudu souboru, posune aktuální pozici v rámci tohoto datového proudu souboru o počet zapsaných bajtů a monitoruje požadavky na zrušení.

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

Zdroj:
FileStream.cs
Zdroj:
FileStream.cs
Zdroj:
FileStream.cs

Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení.

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

Parametry

buffer
Byte[]

Vyrovnávací paměť pro zápis dat.

offset
Int32

Posun buffer bajtů založený na nule, ze kterého se má začít kopírovat bajty do datového proudu.

count
Int32

Maximální počet bajtů k zápisu.

cancellationToken
CancellationToken

Token, který se má monitorovat pro žádosti o zrušení.

Návraty

Task

Úloha, která představuje asynchronní operaci zápisu.

Atributy
ComVisibleAttribute

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

offset nebo count je negativní.

ArgumentException

Součet offset hodnot a count je větší než délka vyrovnávací paměti.

NotSupportedException

Datový proud nepodporuje psaní.

ObjectDisposedException

Datový proud byl odstraněn.

InvalidOperationException

Datový proud je aktuálně používán předchozí operací zápisu.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Příklady

Následující příklad ukazuje, jak zapisovat asynchronně do souboru.

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

Poznámky

Metoda WriteAsync umožňuje provádět operace se soubory náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikacích, kde časově náročná operace streamování může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala.

CanWrite Pomocí vlastnosti určete, zda aktuální instance podporuje zápis.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat Canceled hodnotu vlastnosti Status . Pokud je popisovač souboru odstraněn, bude vrácená úloha obsahovat ObjectDisposedException výjimku ve Exception vlastnosti .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nepouužování, které může vyvolat synchronní protějšek metody. Pokud je do vrácené úlohy uložena výjimka, bude tato výjimka vyvolána, když je úloha očekávána. Výjimky použití, jako ArgumentExceptionje , se stále vyvolává synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Write(Byte[], Int32, Int32).

Viz také

Platí pro

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Zdroj:
FileStream.cs
Zdroj:
FileStream.cs
Zdroj:
FileStream.cs

Asynchronně zapíše sekvenci bajtů z oblasti paměti do aktuálního datového proudu souboru, posune aktuální pozici v rámci tohoto datového proudu souboru o počet zapsaných bajtů a monitoruje požadavky na zrušení.

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

Parametry

buffer
ReadOnlyMemory<Byte>

Oblast paměti, ze které se mají zapisovat data.

cancellationToken
CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask

Úloha, která představuje asynchronní operaci zápisu.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

Metoda WriteAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikacích, kde časově náročná operace streamování může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala.

CanWrite Pomocí vlastnosti určete, zda aktuální instance podporuje zápis.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Task.Status .

Platí pro