Stream.WriteAsync Метод

Определение

Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Перегрузки

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

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteAsync(Byte[], Int32, Int32)

Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

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

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

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[]

Буфер, из которого записываются данные.The buffer to write data from.

offset
Int32

Смещение байтов (начиная с нуля) в buffer, с которого начинается копирование байтов в поток.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32

Максимальное число байтов для записи.The maximum number of bytes to write.

cancellationToken
CancellationToken

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

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

Task

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

Атрибуты

Исключения

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

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

Сумма offset и count больше, чем длина буфера.The sum of offset and count is larger than the buffer length.

Поток не поддерживает запись.The stream does not support writing.

Поток был удален.The stream has been disposed.

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

Комментарии

WriteAsyncМетод позволяет выполнять ресурсоемкие операции ввода-вывода без блокировки основного потока.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Это соображение, связанное с производительностью, особенно важно в приложениях Магазина Windows 8.x и классических приложениях, в которых длительная потоковая операция может блокировать поток пользовательского интерфейса и создавать впечатление, что приложение не работает.This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Асинхронные методы используются в сочетании с async await ключевыми словами и в Visual Basic и C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Используйте CanWrite свойство, чтобы определить, поддерживает ли текущий экземпляр запись.Use the CanWrite property to determine whether the current instance supports writing.

Если операция отменяется до ее завершения, возвращаемая задача содержит Canceled значение для Status Свойства.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

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

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

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию внутри потока на число записанных байтов и отслеживает запросы отмены.Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

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>

Область памяти, из которой будут записываться данные.The region of memory to write data from.

cancellationToken
CancellationToken

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

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

ValueTask

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

Комментарии

WriteAsyncМетод позволяет выполнять ресурсоемкие операции ввода-вывода без блокировки основного потока.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Это соображение, связанное с производительностью, особенно важно в приложениях Магазина Windows 8.x и классических приложениях, в которых длительная потоковая операция может блокировать поток пользовательского интерфейса и создавать впечатление, что приложение не работает.This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Асинхронные методы используются в сочетании с async await ключевыми словами и в Visual Basic и C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Используйте CanWrite свойство, чтобы определить, поддерживает ли текущий экземпляр запись.Use the CanWrite property to determine whether the current instance supports writing.

Если операция отменяется до ее завершения, возвращаемая задача содержит Canceled значение для Status Свойства.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

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

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

WriteAsync(Byte[], Int32, Int32)

Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию внутри потока на число записанных байтов.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

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[]

Буфер, из которого записываются данные.The buffer to write data from.

offset
Int32

Смещение байтов (начиная с нуля) в buffer, с которого начинается копирование байтов в поток.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32

Максимальное число байтов для записи.The maximum number of bytes to write.

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

Task

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

Атрибуты

Исключения

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

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

Сумма offset и count больше, чем длина буфера.The sum of offset and count is larger than the buffer length.

Поток не поддерживает запись.The stream does not support writing.

Поток был удален.The stream has been disposed.

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

Примеры

В следующем примере показано, как асинхронно выполнять запись в файл.The following example shows how to write asynchronously to a file. В примере используется FileStream класс, производный от Stream класса.The example uses the FileStream class, which derives from the Stream class.

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Метод позволяет выполнять ресурсоемкие операции ввода-вывода без блокировки основного потока.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Это соображение, связанное с производительностью, особенно важно в приложениях Магазина Windows 8.x и классических приложениях, в которых длительная потоковая операция может блокировать поток пользовательского интерфейса и создавать впечатление, что приложение не работает.This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Асинхронные методы используются в сочетании с async await ключевыми словами и в Visual Basic и C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Используйте CanWrite свойство, чтобы определить, поддерживает ли текущий экземпляр запись.Use the CanWrite property to determine whether the current instance supports writing.

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