FileStream.WriteAsync Método
Definição
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.
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 de uma região de memória para o fluxo de ficheiros atual, avança a posição atual dentro desse fluxo de ficheiros pelo número de bytes escritos e monitoriza pedidos de cancelamento. |
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:
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
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 Overrides 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.
Devoluções
Uma tarefa que representa a operação de escrita assíncrona.
- Atributos
Exceções
buffer é null.
offset ou count é negativo.
A soma de offset e count é maior do que o comprimento do buffer.
O stream não suporta escrita.
O riacho foi eliminado.
O fluxo está atualmente em uso por uma operação de escrita anterior.
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Exemplos
O exemplo seguinte mostra como escrever assíncronamente num ficheiro.
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
O WriteAsync método permite-lhe realizar operações de ficheiros intensivas em recursos sem bloquear o thread principal. Esta consideração de desempenho é particularmente importante em aplicações onde uma operação de stream demorada pode bloquear a thread da interface e fazer a aplicação parecer que não está a funcionar.
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. Se o handle do ficheiro for eliminado, a tarefa devolvida contém a ObjectDisposedException exceção na Exception propriedade.
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
Aplica-se a
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)
Escreve assíncronamente uma sequência de bytes de uma região de memória para o fluxo de ficheiros atual, avança a posição atual dentro desse fluxo de ficheiros pelo número de bytes escritos e monitoriza pedidos de cancelamento.
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
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
Uma tarefa que representa a operação de escrita assíncrona.
Exceções
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. Esta consideração de desempenho é particularmente importante em aplicações onde uma operação de stream demorada pode bloquear a thread da interface e fazer a aplicação parecer que não está a funcionar.
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 TaskStatus.Canceled valor da Task.Status propriedade.