TextWriter.WriteAsync Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

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

Перегрузки

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

WriteAsync(Char[], Int32, Int32)

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

TextWriter.cs

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

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

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

abstract member WriteAsync : char[] * int * int -> System.Threading.Tasks.Task
override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.Task

Public Overridable 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

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

Комментарии

Класс TextWriter представляет собой абстрактный класс. Следовательно, в коде экземпляр этого объекта не создается. Пример использования WriteAsync метода см. в StreamWriter.WriteAsync разделе метод .

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

См. также раздел

• WriteAsync(Char[], Int32, Int32)
• WriteAsync(Char[], Int32, Int32)

WriteAsync(StringBuilder, CancellationToken)

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

TextWriter.cs

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

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

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

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

Параметры

value

StringBuilder

Строка как построитель строки для записи в текстовый поток.

cancellationToken

CancellationToken

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

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

Task

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

Исключения

OperationCanceledException

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

Комментарии

Этот метод эквивалентен вызову WriteAsync(stringBuilder.ToString()), однако он использует StringBuilder.GetChunks() метод , чтобы избежать создания промежуточной строки.

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

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

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

TextWriter.cs

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

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

abstract member WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

Параметры

buffer

ReadOnlyMemory<Char>

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

cancellationToken

CancellationToken

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

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

Task

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

Исключения

OperationCanceledException

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

WriteAsync(String)

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

TextWriter.cs

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

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

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

abstract member WriteAsync : string -> System.Threading.Tasks.Task
override this.WriteAsync : string -> System.Threading.Tasks.Task

Public Overridable Function WriteAsync (value As String) As Task

Параметры

value

String

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

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Комментарии

Класс TextWriter представляет собой абстрактный класс. Следовательно, в коде экземпляр этого объекта не создается. Пример использования WriteAsync метода см. в StreamWriter.WriteAsync разделе метод .

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

См. также раздел

• WriteAsync(String)
• WriteAsync(String)

WriteAsync(Char[])

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

TextWriter.cs

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

public:
 System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer);

public System.Threading.Tasks.Task WriteAsync (char[]? buffer);

member this.WriteAsync : char[] -> System.Threading.Tasks.Task

Public Function WriteAsync (buffer As Char()) As Task

Параметры

buffer

Char[]

Массив символов, записываемый в текстовый поток. Если buffer имеет значение null, запись не выполняется.

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Комментарии

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

См. также раздел

• StreamWriter
• StringWriter

WriteAsync(Char)

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

TextWriter.cs

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

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

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

abstract member WriteAsync : char -> System.Threading.Tasks.Task
override this.WriteAsync : char -> System.Threading.Tasks.Task

Public Overridable Function WriteAsync (value As Char) As Task

Параметры

value

Char

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

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Комментарии

Класс TextWriter представляет собой абстрактный класс. Следовательно, в коде экземпляр этого объекта не создается. Пример использования WriteAsync метода см. в StreamWriter.WriteAsync разделе метод .

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

См. также раздел

• WriteAsync(Char)
• WriteAsync(Char)