StreamWriter.WriteAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Escribe de forma asincrónica datos en la secuencia.

Sobrecargas

WriteAsync(Char)	Escribe de forma asincrónica un carácter en la secuencia.
WriteAsync(String)	Escribe de forma asincrónica una cadena en la secuencia.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Escribe de forma asincrónica una región de memoria de caracteres en la secuencia.
WriteAsync(Char[], Int32, Int32)	Escribe de forma asincrónica una submatriz de caracteres en la secuencia.

WriteAsync(Char)

Source:

StreamWriter.cs

Escribe de forma asincrónica un carácter en la secuencia.

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

Carácter que se va a escribir en la secuencia.

Devoluciones

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ObjectDisposedException

Se desecha el sistema de escritura de secuencias.

InvalidOperationException

El escritor de secuencias está actualmente en uso por una operación de escritura anterior.

Ejemplos

En el ejemplo siguiente se muestra cómo escribir un carácter único (la letra "a") en un archivo de texto mediante el 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

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Write(Char).

WriteAsync(String)

Source:

StreamWriter.cs

Escribe de forma asincrónica una cadena en la secuencia.

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

Cadena que se debe escribir en la secuencia. Si value es null, no se escribe nada.

Devoluciones

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ObjectDisposedException

Se desecha el sistema de escritura de secuencias.

InvalidOperationException

El escritor de secuencias está actualmente en uso por una operación de escritura anterior.

Ejemplos

En el ejemplo siguiente se muestra cómo escribir una cadena en un archivo de texto mediante el 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

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Write(String).

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

StreamWriter.cs

Escribe de forma asincrónica una región de memoria de caracteres en la secuencia.

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>

Región de memoria de caracteres que se va a escribir en la secuencia.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

WriteAsync(Char[], Int32, Int32)

Source:

StreamWriter.cs

Escribe de forma asincrónica una submatriz de caracteres en la secuencia.

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

Matriz de caracteres que contiene los datos que se van a escribir.

index

Int32

Posición del carácter en el búfer donde comienza la lectura de datos.

count

Int32

Número máximo de caracteres que se van a escribir.

Devoluciones

Task

Tarea que representa la operación de escritura asincrónica.

Excepciones

ArgumentNullException

buffer es null.

ArgumentException

index más count es mayor que la longitud del búfer.

ArgumentOutOfRangeException

index o count es negativo.

ObjectDisposedException

Se desecha el sistema de escritura de secuencias.

InvalidOperationException

El escritor de secuencias está actualmente en uso por una operación de escritura anterior.

Ejemplos

En el ejemplo siguiente se muestra cómo escribir varios caracteres en un archivo de texto mediante el 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

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Write(Char[], Int32, Int32).