StreamWriter.WriteAsync Метод

Определение

Пространство имен:

System.IO

Сборка:

System.Runtime.dll

Выполняет асинхронную запись данных в поток.

Перегрузки

WriteAsync(Char)	Асинхронно записывает символ в поток.
WriteAsync(String)	Асинхронно записывает строку в поток.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Выполняет асинхронную запись области памяти символов в поток.
WriteAsync(Char[], Int32, Int32)	Асинхронно записывает дочерний массив символов в поток.

WriteAsync(Char)

Исходный код:

StreamWriter.cs

Асинхронно записывает символ в поток.

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

Параметры

value

Char

Символ, записываемый в поток.

Возвращаемое значение

Task

Задача, представляющая асинхронную операцию записи.

Исключения

ObjectDisposedException

Удалено средство записи потока.

InvalidOperationException

Средство записи потока в настоящее время используется предыдущей операцией записи.

Примеры

В следующем примере показано, как записать один символ (букву "a") в текстовый файл с помощью WriteAsync(Char) метода .

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

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Write(Char).

WriteAsync(String)

Исходный код:

StreamWriter.cs

Асинхронно записывает строку в поток.

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

Параметры

value

String

Строка, записываемая в поток. Если value имеет значение null, запись не выполняется.

Возвращаемое значение

Task

Задача, представляющая асинхронную операцию записи.

Исключения

ObjectDisposedException

Удалено средство записи потока.

InvalidOperationException

Средство записи потока в настоящее время используется предыдущей операцией записи.

Примеры

В следующем примере показано, как записать строку в текстовый файл с помощью WriteAsync(String) метода .

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

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Write(String).

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Исходный код:

StreamWriter.cs

Выполняет асинхронную запись области памяти символов в поток.

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

Параметры

buffer

ReadOnlyMemory<Char>

Область памяти символов для записи в поток.

cancellationToken

CancellationToken

Токен для отслеживания запросов отмены. Значение по умолчанию — None.

Возвращаемое значение

Task

Задача, представляющая асинхронную операцию записи.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

WriteAsync(Char[], Int32, Int32)

Исходный код:

StreamWriter.cs

Асинхронно записывает дочерний массив символов в поток.

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

Параметры

buffer

Char[]

Массив символов, содержащий записываемые данные.

index

Int32

Положение символа в буфере с которого начинается чтение данных.

count

Int32

Наибольшее количество символов для записи.

Возвращаемое значение

Task

Задача, представляющая асинхронную операцию записи.

Исключения

ArgumentNullException

buffer имеет значение null.

ArgumentException

Сумма значений параметров index и count превышает длину буфера.

ArgumentOutOfRangeException

index или count является отрицательным значением.

ObjectDisposedException

Удалено средство записи потока.

InvalidOperationException

Средство записи потока в настоящее время используется предыдущей операцией записи.

Примеры

В следующем примере показано, как записать несколько символов в текстовый файл с помощью WriteAsync(Char[], Int32, Int32) метода .

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

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Write(Char[], Int32, Int32).