StreamWriter.WriteLineAsync Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

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

Перегрузки

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

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)

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

StreamWriter.cs

Асинхронно записывает в поток текстовое представление области памяти символов, за которым следует знак конца строки.

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

Параметры

buffer

ReadOnlyMemory<Char>

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

cancellationToken

CancellationToken

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

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

Task

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

Исключения

OperationCanceledException

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

Комментарии

Признак конца строки определяется полем CoreNewLine .

WriteLineAsync()

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

StreamWriter.cs

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

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

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

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

Public Overrides Function WriteLineAsync () As Task

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Комментарии

Признак конца строки определяется свойством TextWriter.NewLine .

WriteLineAsync(Char)

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

StreamWriter.cs

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

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

Параметры

value

Char

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

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Примеры

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

using System.IO;

namespace ConsoleApplication
{
    class Program3
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync('a');
                await writer.WriteLineAsync('b');
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim firstChar As Char = "a"
        Dim secondChar As Char = "b"
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync(firstChar)
            Await writer.WriteLineAsync(secondChar)
        End Using
    End Sub
End Module

Комментарии

Признак конца строки определяется свойством TextWriter.NewLine .

WriteLineAsync(String)

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

StreamWriter.cs

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

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

Параметры

value

String

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

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

Task

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

Исключения

ObjectDisposedException

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

InvalidOperationException

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

Примеры

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

using System.IO;

namespace ConsoleApplication
{
    class Program4
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync("First line of example");
                await writer.WriteLineAsync("and second line");
            }
        }
    }
}

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.WriteLineAsync("First line of example")
            Await writer.WriteLineAsync("and second line")
        End Using
    End Sub
End Module

Комментарии

Признак конца строки определяется свойством TextWriter.NewLine .

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

WriteLineAsync(Char[], Int32, Int32)

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

StreamWriter.cs

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

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

Параметры

buffer

Char[]

Массив символов, из которого записываются данные.

index

Int32

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

count

Int32

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

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

Task

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

Исключения

ArgumentNullException

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

ArgumentException

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

ArgumentOutOfRangeException

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

ObjectDisposedException

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

InvalidOperationException

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

Примеры

В следующем примере показано, как записать символы в две отдельные строки в текстовом файле с помощью WriteLineAsync(Char[], Int32, Int32) метода . Первая строка содержит первые 11 символов из строки (буквы "Первая строка" и пробел). Вторая строка содержит оставшиеся символы из строки (буквы "и вторая строка").

using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program6
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            UnicodeEncoding ue = new UnicodeEncoding();
            char[] charsToAdd = ue.GetChars(ue.GetBytes("First line and second line"));
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync(charsToAdd, 0, 11);
                await writer.WriteLineAsync(charsToAdd, 11, charsToAdd.Length - 11);
            }
        }
    }
}

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("First line and second line"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync(charsToAdd, 0, 11)
            Await writer.WriteLineAsync(charsToAdd, 11, charsToAdd.Length - 11)
        End Using
    End Sub
End Module

Комментарии

Признак конца строки определяется свойством TextWriter.NewLine .