StreamWriter.WriteAsync Метод

Определение

Выполняет асинхронную запись данных в поток.Asynchronously writes data to the stream.

Перегрузки

WriteAsync(Char)

Асинхронно записывает символ в поток.Asynchronously writes a character to the stream.

WriteAsync(String)

Асинхронно записывает строку в поток.Asynchronously writes a string to the stream.

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Выполняет асинхронную запись области памяти символов в поток.Asynchronously writes a character memory region to the stream.

WriteAsync(Char[], Int32, Int32)

Асинхронно записывает дочерний массив символов в поток.Asynchronously writes a subarray of characters to the stream.

WriteAsync(Char)

Асинхронно записывает символ в поток.Asynchronously writes a character to the stream.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(char value);
[System.Runtime.InteropServices.ComVisible(false)]
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

Символ, записываемый в поток.The character to write to the stream.

Возвраты

Задача, представляющая асинхронную операцию записи.A task that represents the asynchronous write operation.

Атрибуты

Исключения

Удалено средство записи потока.The stream writer is disposed.

Средство записи потока в настоящее время используется предыдущей операцией записи.The stream writer is currently in use by a previous write operation.

Примеры

В следующем примере показано, как записать один символ (букву "a") в текстовый файл с помощью WriteAsync(Char) метода.The following example shows how to write a single character (the letter "a") to a text file by using the WriteAsync(Char) method.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            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

WriteAsync(String)

Асинхронно записывает строку в поток.Asynchronously writes a string to the stream.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(System::String ^ value);
[System.Runtime.InteropServices.ComVisible(false)]
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

Строка, записываемая в поток.The string to write to the stream. Если value имеет значение null, запись не выполняется.If value is null, nothing is written.

Возвраты

Задача, представляющая асинхронную операцию записи.A task that represents the asynchronous write operation.

Атрибуты

Исключения

Удалено средство записи потока.The stream writer is disposed.

Средство записи потока в настоящее время используется предыдущей операцией записи.The stream writer is currently in use by a previous write operation.

Примеры

В следующем примере показано, как записать строку в текстовый файл с помощью WriteAsync(String) метода.The following example shows how to write a string to a text file by using the WriteAsync(String) method.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            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

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Выполняет асинхронную запись области памяти символов в поток.Asynchronously writes a character memory region to the stream.

public override System.Threading.Tasks.Task WriteAsync (ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = null);
override this.WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Параметры

buffer
ReadOnlyMemory<Char>

Область памяти символов для записи в поток.The character memory region to write to the stream.

cancellationToken
CancellationToken

Токен для отслеживания запросов отмены.The token to monitor for cancellation requests. Значение по умолчанию — None.The default value is None.

Возвраты

Задача, представляющая асинхронную операцию записи.A task that represents the asynchronous write operation.

WriteAsync(Char[], Int32, Int32)

Асинхронно записывает дочерний массив символов в поток.Asynchronously writes a subarray of characters to the stream.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
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[]

Массив символов, содержащий записываемые данные.A character array that contains the data to write.

index
Int32

Положение символа в буфере с которого начинается чтение данных.The character position in the buffer at which to begin reading data.

count
Int32

Наибольшее количество символов для записи.The maximum number of characters to write.

Возвраты

Задача, представляющая асинхронную операцию записи.A task that represents the asynchronous write operation.

Атрибуты

Исключения

Свойство buffer имеет значение null.buffer is null.

Сумма значений параметров index и count превышает длину буфера.The index plus count is greater than the buffer length.

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

Удалено средство записи потока.The stream writer is disposed.

Средство записи потока в настоящее время используется предыдущей операцией записи.The stream writer is currently in use by a previous write operation.

Примеры

В следующем примере показано, как записать несколько символов в текстовый файл с помощью WriteAsync(Char[], Int32, Int32) метода.The following example shows how to write multiple characters to a text file by using the WriteAsync(Char[], Int32, Int32) method.

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            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

Применяется к