StringWriter.WriteLineAsync Método

Definição

Namespace:

System.IO

Assemblies:

netstandard.dll, System.Runtime.dll

Grava dados de forma assíncrona na cadeia de caracteres, seguido por um terminador de linha.

Sobrecargas

Nome	Description
WriteLineAsync(StringBuilder, CancellationToken)	Grava de forma assíncrona a representação de cadeia de caracteres do construtor de cadeias de caracteres na cadeia de caracteres atual, seguida por um terminador de linha.
WriteLineAsync(Char)	Grava de forma assíncrona um caractere na cadeia de caracteres, seguido por um terminador de linha.
WriteLineAsync(String)	Grava de forma assíncrona uma cadeia de caracteres na cadeia de caracteres atual, seguida por um terminador de linha.
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Grava de forma assíncrona a representação da cadeia de caracteres da região de memória dos caracteres na cadeia de caracteres atual, seguida por um terminador de linha.
WriteLineAsync(Char[], Int32, Int32)	Grava de forma assíncrona uma subarray de caracteres na cadeia de caracteres, seguida por um terminador de linha.

WriteLineAsync(StringBuilder, CancellationToken)

Origem:

StringWriter.cs

Grava de forma assíncrona a representação de cadeia de caracteres do construtor de cadeias de caracteres na cadeia de caracteres atual, seguida por um terminador de linha.

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

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

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

Parâmetros

value

StringBuilder

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

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.

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 WriteLine(StringBuilder).

WriteLineAsync(Char)

Origem:

StringWriter.cs

Grava de forma assíncrona um caractere na cadeia de caracteres, seguido por um terminador de linha.

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

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

override this.WriteLineAsync : char -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (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á atualmente em uso por uma operação de gravação anterior.

Exemplos

O exemplo a seguir mostra como escrever caracteres usando o WriteLineAsync(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.WriteLineAsync(c);
                }
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// a
// n
// d
//
// c
// h
// a
// r
// s
//
// t
// o
//
// a
// d
// d
//

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.WriteLineAsync(c)
            Next
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' a
' n
' d 
'
' c
' h
' a
' r
' s
' 
' t
' o
'
' a
' d
' d
'

Comentários

O terminador de linha é definido pela NewLine propriedade.

WriteLineAsync(String)

Origem:

StringWriter.cs

Grava de forma assíncrona uma cadeia de caracteres na cadeia de caracteres atual, seguida por um terminador de linha.

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

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

override this.WriteLineAsync : string -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (value As String) As Task

Parâmetros

value

String

A cadeia de caracteres a ser gravada. Se o valor for null, apenas um terminador de linha será gravado.

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á atualmente em uso por uma operação de gravação anterior.

Exemplos

O exemplo a seguir mostra como escrever uma cadeia de caracteres usando o WriteLineAsync(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.WriteLineAsync("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.WriteLineAsync("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

O terminador de linha é definido pela NewLine propriedade.

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)

Origem:

StringWriter.cs

Grava de forma assíncrona a representação da cadeia de caracteres da região de memória dos caracteres na cadeia de caracteres atual, seguida por um terminador de linha.

public override System.Threading.Tasks.Task WriteLineAsync(ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteLineAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As Task

Parâmetros

buffer

ReadOnlyMemory<Char>

Uma região de memória de caracteres a serem gravados na cadeia de caracteres.

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.

WriteLineAsync(Char[], Int32, Int32)

Origem:

StringWriter.cs

Grava de forma assíncrona uma subarray de caracteres na cadeia de caracteres, seguida por um terminador de linha.

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task WriteLineAsync(char[] buffer, int index, int count);

override this.WriteLineAsync : char[] * int * int -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (buffer As Char(), index As Integer, count As Integer) As Task

Parâmetros

buffer

Char[]

A matriz de caracteres da qual gravar dados.

index

Int32

A posição no buffer na qual iniciar a leitura de 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.

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

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como escrever caracteres usando o WriteLineAsync(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.WriteLineAsync(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.WriteLineAsync(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

O terminador de linha é definido pela NewLine propriedade.