TextWriter.WriteAsync Метод

Определение

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

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

Записывает данные в текстовый поток асинхронно.

Перегрузки

Имя	Описание
WriteAsync(Char[], Int32, Int32)	Записывает вложенные символы в текстовый поток асинхронно.
WriteAsync(StringBuilder, CancellationToken)	Асинхронно записывает построитель строк в текстовый поток.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Асинхронно записывает область памяти символов в текстовый поток.
WriteAsync(Char)	Записывает символ в текстовый поток асинхронно.
WriteAsync(String)	Записывает строку в текстовый поток асинхронно.
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

count Плюс index больше длины буфера.

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

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