Stream.WriteAsync Метод

Ссылка

Определение

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

Сборка:: System.Runtime.dll

Сборка:: netstandard.dll

Сборка:: System.IO.dll

Сборка:: mscorlib.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.

Перегрузки

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

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.

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

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

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

Параметры

buffer: ReadOnlyMemory<Byte>

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

cancellationToken: CancellationToken

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

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

ValueTask

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

Этот WriteAsync метод позволяет выполнять ресурсоемкие операции ввода-вывода, не блокируя основной поток. Это соображение, связанное с производительностью, особенно важно в приложениях Магазина Windows 8.x и классических приложениях, в которых длительная потоковая операция может блокировать поток пользовательского интерфейса и создавать впечатление, что приложение не работает. Асинхронные методы используются в сочетании с async await ключевыми словами в Visual Basic и C#.

CanWrite Используйте свойство, чтобы определить, поддерживает ли текущий экземпляр запись.

Если операция отменена до ее завершения, возвращаемая задача содержит Canceled значение свойства Status .

Пример см. в описании перегрузки WriteAsync(Byte[], Int32, Int32) .

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

WriteAsync(Byte[], Int32, Int32)

public:
 System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count);

public System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count);

[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count);

member this.WriteAsync : byte[] * int * int -> System.Threading.Tasks.Task

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.WriteAsync : byte[] * int * int -> System.Threading.Tasks.Task

Public Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer) As Task

Параметры

buffer: Byte[]

Буфер, из которого записываются данные.

offset: Int32

Смещение байтов (начиная с нуля) в buffer, с которого начинается копирование байтов в поток.

count: Int32

Максимальное число байтов для записи.

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

Task

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

Атрибуты: ComVisibleAttribute

Исключения

ArgumentNullException

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

ArgumentOutOfRangeException

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

ArgumentException

Сумма offset и count больше, чем длина буфера.

NotSupportedException

Поток не поддерживает запись.

ObjectDisposedException

Поток был удален.

InvalidOperationException

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

Примеры

В следующем примере показано, как асинхронно записывать данные в файл. В примере используется FileStream класс, производный Stream от класса.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

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

WriteAsync(Byte[], Int32, Int32, CancellationToken)

public:
 virtual System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

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

[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

Параметры

buffer: Byte[]

Буфер, из которого записываются данные.

offset: Int32

Смещение байтов (начиная с нуля) в buffer, с которого начинается копирование байтов в поток.

count: Int32

Максимальное число байтов для записи.

cancellationToken: CancellationToken

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

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

Task

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

Атрибуты: ComVisibleAttribute

Исключения

ArgumentNullException

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

ArgumentOutOfRangeException

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

ArgumentException

Сумма offset и count больше, чем длина буфера.

NotSupportedException

Поток не поддерживает запись.

ObjectDisposedException

Поток был удален.

InvalidOperationException

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

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

Отмена

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

Stream.WriteAsync Метод

Определение

Перегрузки

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Параметры

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

Комментарии

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

WriteAsync(Byte[], Int32, Int32)

Параметры

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

Исключения

Примеры

Комментарии

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

WriteAsync(Byte[], Int32, Int32, CancellationToken)

Параметры

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

Исключения

Комментарии

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

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

Дополнительные ресурсы