Stream.WriteAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů.

Přetížení

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů a monitoruje žádosti o zrušení.
WriteAsync(Byte[], Int32, Int32)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů a monitoruje žádosti o zrušení.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Zdroj:

Stream.cs

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

public virtual System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

abstract member WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Overridable Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parametry

buffer

ReadOnlyMemory<Byte>

Oblast paměti, ze které chcete 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 je uložena ve vrácené úloze.

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 aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanWrite Pomocí vlastnosti určete, jestli 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 .

Příklad najdete v WriteAsync(Byte[], Int32, Int32) tématu přetížení.

WriteAsync(Byte[], Int32, Int32)

Zdroj:

Stream.cs

Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů.

public:
 System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count);

public System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count);

member this.WriteAsync : byte[] * int * int -> System.Threading.Tasks.Task

Public Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer) As Task

Parametry

buffer

Byte[]

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

offset

Int32

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

count

Int32

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

Návraty

Task

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

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

offset nebo count je negativní.

ArgumentException

Součet offset 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.

Příklady

Následující příklad ukazuje, jak asynchronně zapisovat do souboru. Příklad používá FileStream třídu, která je odvozena od Stream třídy.

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 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 aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

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

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Write(Byte[], Int32, Int32).

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

Zdroj:

Stream.cs

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

public:
 virtual System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

abstract member WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable 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 bajtů buffer založených na nule, ze kterého chcete 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í. Výchozí hodnota je None.

Návraty

Task

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

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

offset nebo count je negativní.

ArgumentException

Součet offset 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 je uložena ve vrácené úloze.

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 aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

CanWrite Pomocí vlastnosti určete, jestli 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 .

Příklad najdete v WriteAsync(Byte[], Int32, Int32) tématu přetížení.

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Write(Byte[], Int32, Int32).

Viz také

• Zrušení