StringWriter.WriteAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Grava dados na cadeia de caracteres de forma assíncrona.

Sobrecargas

WriteAsync(Char)	Grava um caractere na cadeia de caracteres de forma assíncrona.
WriteAsync(String)	Grava uma cadeia de caracteres na cadeia de caracteres atual de forma assíncrona.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Grava uma região da memória de caracteres na cadeia de caracteres de forma assíncrona.
WriteAsync(StringBuilder, CancellationToken)	Grava de forma assíncrona a representação de texto de um construtor de cadeia de caracteres na cadeia de caracteres.
WriteAsync(Char[], Int32, Int32)	Grava uma submatriz de caracteres na cadeia de caracteres de forma assíncrona.

WriteAsync(Char)

Origem:

StringWriter.cs

Grava um caractere na cadeia de caracteres de forma assíncrona.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(char value);

public override System.Threading.Tasks.Task WriteAsync (char value);

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 na cadeia de caracteres.

Retornos

Task

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

Exceções

ObjectDisposedException

O gravador de cadeia de caracteres é descartado.

InvalidOperationException

O gravador de cadeia de caracteres está sendo usado no momento por uma operação de gravação anterior.

Exemplos

O exemplo a seguir mostra como escrever caracteres usando o WriteAsync(Char) método .

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));
                foreach (char c in charsToAdd)
                {
                    await writer.WriteAsync(c);
                }
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and chars to add
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))
            For Each c As Char In charsToAdd
                Await writer.WriteAsync(c)
            Next
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and chars to add
'

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona 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).

WriteAsync(String)

Origem:

StringWriter.cs

Grava uma cadeia de caracteres na cadeia de caracteres atual de forma assíncrona.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(System::String ^ value);

public override System.Threading.Tasks.Task WriteAsync (string? value);

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. Se value for null, nada será gravado no fluxo de texto.

Retornos

Task

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

Exceções

ObjectDisposedException

O gravador de cadeia de caracteres é descartado.

InvalidOperationException

O gravador de cadeia de caracteres está sendo usado no momento por uma operação de gravação anterior.

Exemplos

O exemplo a seguir mostra como escrever uma cadeia de caracteres usando o WriteAsync(String) método .

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                await writer.WriteAsync("and add characters through StringWriter");
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and add characters through StringWriter
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)
            Await writer.WriteAsync("and add characters through StringWriter")
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and add characters through StringWriter
'

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona 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).

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Origem:

StringWriter.cs

Grava uma região da memória de caracteres na cadeia de caracteres de forma assíncrona.

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 da memória do caractere a ser gravado na cadeia de caracteres.

cancellationToken

CancellationToken

O token a se monitorar 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.

WriteAsync(StringBuilder, CancellationToken)

Origem:

StringWriter.cs

Grava de forma assíncrona a representação de texto de um construtor de cadeia de caracteres na cadeia de caracteres.

public override System.Threading.Tasks.Task WriteAsync (System.Text.StringBuilder? value, System.Threading.CancellationToken cancellationToken = default);

override this.WriteAsync : System.Text.StringBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (value As StringBuilder, Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

value

StringBuilder

O construtor de cadeia de caracteres a ser gravado na cadeia de caracteres.

cancellationToken

CancellationToken

O token a se monitorar 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.

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona 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(StringBuilder).

WriteAsync(Char[], Int32, Int32)

Origem:

StringWriter.cs

Grava uma submatriz de caracteres na cadeia de caracteres de forma assíncrona.

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

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[]

A matriz de caracteres da qual os dados serão gravados.

index

Int32

A posição no buffer em que a leitura de dados é iniciada.

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.

Exceções

ArgumentNullException

buffer é null.

ArgumentException

O index mais count é maior que o comprimento do buffer.

ArgumentOutOfRangeException

index ou count é negativo.

ObjectDisposedException

O gravador de cadeia de caracteres é descartado.

InvalidOperationException

O gravador de cadeia de caracteres está sendo usado no momento por uma operação de gravação anterior.

Exemplos

O exemplo a seguir mostra como escrever caracteres usando o WriteAsync(Char[], Int32, Int32) método .

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));

                await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length);

                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and chars to add
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))

            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)

            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and chars to add
'

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona 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).