Stream.WriteAsync Método

Definição

Espaço de Nomes:: System.IO

Assemblagens:: mscorlib.dll, System.IO.dll

Assemblagem:: mscorlib.dll

Assemblagem:: System.IO.dll

Assemblagem:: netstandard.dll

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

Escreve assíncronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes escritos.

Sobrecargas

Name	Description
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Escreve assíncronamente uma sequência de bytes no fluxo atual, avança a posição atual dentro deste fluxo pelo número de bytes escritos e monitoriza pedidos de cancelamento.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Escreve assíncronamente uma sequência de bytes no fluxo atual, avança a posição atual dentro deste fluxo pelo número de bytes escritos e monitoriza pedidos de cancelamento.
WriteAsync(Byte[], Int32, Int32)	Escreve assíncronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes escritos.

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

Escreve assíncronamente uma sequência de bytes no fluxo atual, avança a posição atual dentro deste fluxo pelo número de bytes escritos e monitoriza pedidos de cancelamento.

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

[System.Runtime.InteropServices.ComVisible(false)]
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

[<System.Runtime.InteropServices.ComVisible(false)>]
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

Parâmetros

buffer: Byte[]

O buffer para escrever dados.

offset: Int32

O deslocamento de bytes base em zero a buffer partir do qual começar a copiar bytes para o fluxo.

count: Int32

O número máximo de bytes a escrever.

cancellationToken: CancellationToken

O token para monitorizar pedidos de cancelamento. O valor predefinido é None.

Devoluções

Task

Uma tarefa que representa a operação de escrita assíncrona.

Atributos: ComVisibleAttribute

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

ArgumentException

A soma de offset e count é maior do que o comprimento do buffer.

NotSupportedException

O stream não suporta escrita.

ObjectDisposedException

O riacho foi eliminado.

InvalidOperationException

O fluxo está atualmente em uso por uma operação de escrita anterior.

OperationCanceledException

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Observações

O WriteAsync método permite-lhe realizar operações de I/O que consomem muitos recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows Store 8.x ou aplicativo da área de trabalho, onde uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer com que seu aplicativo pareça como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await em Visual Basic e C#.

Use a CanWrite propriedade para determinar se a instância atual suporta escrita.

Se a operação for cancelada antes de ser concluída, a tarefa devolvida contém o Canceled valor da Status propriedade.

Por exemplo, veja a WriteAsync(Byte[], Int32, Int32) sobrecarga.

Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por Write(Byte[], Int32, Int32).

Ver também

Cancelamento

Aplica-se a

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Escreve assíncronamente uma sequência de bytes no fluxo atual, avança a posição atual dentro deste fluxo pelo número de bytes escritos e monitoriza pedidos de cancelamento.

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

Parâmetros

buffer: ReadOnlyMemory<Byte>

A região de memória de onde se pode escrever dados.

cancellationToken: CancellationToken

O token para monitorizar pedidos de cancelamento. O valor predefinido é None.

Devoluções

ValueTask

Uma tarefa que representa a operação de escrita assíncrona.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Observações

Use a CanWrite propriedade para determinar se a instância atual suporta escrita.

Se a operação for cancelada antes de ser concluída, a tarefa devolvida contém o Canceled valor da Status propriedade.

Por exemplo, veja a WriteAsync(Byte[], Int32, Int32) sobrecarga.

Aplica-se a

WriteAsync(Byte[], Int32, Int32)

Escreve assíncronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes escritos.

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

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

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

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.WriteAsync : byte[] * int * int -> System.Threading.Tasks.Task

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

Parâmetros

buffer: Byte[]

O buffer para escrever dados.

offset: Int32

O deslocamento de bytes base em zero a buffer partir do qual começar a copiar bytes para o fluxo.

count: Int32

O número máximo de bytes a escrever.

Devoluções

Task

Uma tarefa que representa a operação de escrita assíncrona.

Atributos: ComVisibleAttribute

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

ArgumentException

A soma de offset e count é maior do que o comprimento do buffer.

NotSupportedException

O stream não suporta escrita.

ObjectDisposedException

O riacho foi eliminado.

InvalidOperationException

O fluxo está atualmente em uso por uma operação de escrita anterior.

Exemplos

O exemplo seguinte mostra como escrever assíncronamente num ficheiro. O exemplo utiliza a FileStream classe, que deriva da Stream classe.

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

Observações

Use a CanWrite propriedade para determinar se a instância atual suporta escrita.

Aplica-se a

Comentários

Esta página foi útil?