StreamWriter.WriteAsync Método

Definição

Namespace:
System.IO
Assemblies:
mscorlib.dll, System.IO.dll
Assembly:
mscorlib.dll
Assembly:
System.IO.dll
Assembly:
netstandard.dll

Grava dados de forma assíncrona no fluxo.

Sobrecargas

Nome Description
WriteAsync(Char[], Int32, Int32)

Grava de forma assíncrona uma subarray de caracteres no fluxo.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Grava de forma assíncrona uma região de memória de caractere no fluxo.
WriteAsync(Char)

Grava de forma assíncrona um caractere no fluxo.
WriteAsync(String)

Grava de forma assíncrona uma cadeia de caracteres no fluxo.

WriteAsync(Char[], Int32, Int32)

Grava de forma assíncrona uma subarray de caracteres no fluxo.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer, int index, int count);
public override System.Threading.Tasks.Task WriteAsync(char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync(char[] buffer, int index, int count);
override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (buffer As Char(), index As Integer, count As Integer) As Task

Parâmetros

buffer
Char[]

Uma matriz de caracteres que contém os dados a serem gravados.

index
Int32

A posição do caractere no buffer no qual começar a ler dados.

count
Int32

O número máximo de caracteres a serem gravados.

Retornos

Task

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

Atributos
ComVisibleAttribute

Exceções

ArgumentNullException

buffer é null.

ArgumentException

A index adição count é maior que o tamanho do buffer.

ArgumentOutOfRangeException

index ou count é negativo.

ObjectDisposedException

O gravador de fluxo é descartado.

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como gravar vários caracteres em um arquivo de texto usando o WriteAsync(Char[], Int32, Int32) método.

using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program5
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            UnicodeEncoding ue = new UnicodeEncoding();
            char[] charsToAdd = ue.GetChars(ue.GetBytes("Example string"));
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim ue As UnicodeEncoding = New UnicodeEncoding()
        Dim charsToAdd() = ue.GetChars(ue.GetBytes("Example string"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)
        End Using
    End Sub
End Module

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Write(Char[], Int32, Int32).

Aplica-se a

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Grava de forma assíncrona uma região de memória de caractere no fluxo.

public override System.Threading.Tasks.Task WriteAsync(ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

buffer
ReadOnlyMemory<Char>

A região de memória do caractere a ser gravada no fluxo.

cancellationToken
CancellationToken

O token a ser monitorado para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

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

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Aplica-se a

WriteAsync(Char)

Grava de forma assíncrona um caractere no fluxo.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(char value);
public override System.Threading.Tasks.Task WriteAsync(char value);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync(char value);
override this.WriteAsync : char -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : char -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (value As Char) As Task

Parâmetros

value
Char

O caractere a ser gravado no fluxo.

Retornos

Task

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

Atributos
ComVisibleAttribute

Exceções

ObjectDisposedException

O gravador de fluxo é descartado.

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como gravar um único caractere (a letra "a") em um arquivo de texto usando o WriteAsync(Char) método.

using System.IO;

namespace ConsoleApplication
{
    class Program1
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync('a');
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim oneLetter As Char = "a"
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(oneLetter)
        End Using
    End Sub
End Module

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Write(Char).

Aplica-se a

WriteAsync(String)

Grava de forma assíncrona uma cadeia de caracteres no fluxo.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(System::String ^ value);
public override System.Threading.Tasks.Task WriteAsync(string value);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync(string value);
override this.WriteAsync : string -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : string -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (value As String) As Task

Parâmetros

value
String

A cadeia de caracteres a ser gravada no fluxo. Se value for null, nada está escrito.

Retornos

Task

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

Atributos
ComVisibleAttribute

Exceções

ObjectDisposedException

O gravador de fluxo é descartado.

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como gravar uma cadeia de caracteres em um arquivo de texto usando o WriteAsync(String) método.

using System.IO;

namespace ConsoleApplication
{
    class Program2
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync("Example text as string");
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync("Example text as string")
        End Using
    End Sub
End Module

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Write(String).

Aplica-se a