Stream.WriteAsync Metoda

Definicja

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów.Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Przeciążenia

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

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia, przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów i monitoruje żądania anulowania.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)

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia, przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów i monitoruje żądania anulowania.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)

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów.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)

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia, przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów i monitoruje żądania anulowania.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

Parametry

buffer
Byte[]

Bufor, z którego mają zostać zapisane dane.The buffer to write data from.

offset
Int32

Przesunięcie bajtu (liczony od zera), buffer od którego należy rozpocząć kopiowanie bajtów do strumienia.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32

Maksymalna liczba bajtów do zapisania.The maximum number of bytes to write.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania.The token to monitor for cancellation requests. Wartość domyślna to None.The default value is None.

Zwraca

Task

Zadanie, które reprezentuje asynchroniczny zapis operacji.A task that represents the asynchronous write operation.

Atrybuty

Wyjątki

buffer to null.buffer is null.

offset lub count jest ujemna.offset or count is negative.

Suma offset i count jest większa niż długość buforu.The sum of offset and count is larger than the buffer length.

Strumień nie obsługuje zapisu.The stream does not support writing.

Strumień został usunięty.The stream has been disposed.

Strumień jest obecnie używany przez poprzednią operację zapisu.The stream is currently in use by a previous write operation.

Uwagi

WriteAsyncMetoda umożliwia wykonywanie operacji We/Wy intensywnie obciążających zasoby bez blokowania wątku głównego.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Ten wpływ na wydajność jest szczególnie istotny w aplikacji do sklepu Windows 8. x lub aplikacji klasycznej, w której czasochłonna operacja przesyłania strumieniowego może blokować wątek interfejsu użytkownika i sprawiać, że aplikacja wygląda tak, jakby nie działała.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. Metody asynchroniczne są używane w połączeniu z async await słowami kluczowymi i w Visual Basic i C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Użyj CanWrite właściwości, aby określić, czy bieżące wystąpienie obsługuje zapisywanie.Use the CanWrite property to determine whether the current instance supports writing.

Jeśli operacja zostanie anulowana przed zakończeniem, zwrócone zadanie zawiera Canceled wartość Status właściwości.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Aby zapoznać się z przykładem, zapoznaj się z WriteAsync(Byte[], Int32, Int32) przeciążeniem.For an example, see the WriteAsync(Byte[], Int32, Int32) overload.

Dotyczy

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia, przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów i monitoruje żądania anulowania.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

Parametry

buffer
ReadOnlyMemory<Byte>

Region pamięci, z której mają zostać zapisane dane.The region of memory to write data from.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania.The token to monitor for cancellation requests. Wartość domyślna to None.The default value is None.

Zwraca

ValueTask

Zadanie, które reprezentuje asynchroniczny zapis operacji.A task that represents the asynchronous write operation.

Uwagi

WriteAsyncMetoda umożliwia wykonywanie operacji We/Wy intensywnie obciążających zasoby bez blokowania wątku głównego.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Ten wpływ na wydajność jest szczególnie istotny w aplikacji do sklepu Windows 8. x lub aplikacji klasycznej, w której czasochłonna operacja przesyłania strumieniowego może blokować wątek interfejsu użytkownika i sprawiać, że aplikacja wygląda tak, jakby nie działała.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. Metody asynchroniczne są używane w połączeniu z async await słowami kluczowymi i w Visual Basic i C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Użyj CanWrite właściwości, aby określić, czy bieżące wystąpienie obsługuje zapisywanie.Use the CanWrite property to determine whether the current instance supports writing.

Jeśli operacja zostanie anulowana przed zakończeniem, zwrócone zadanie zawiera Canceled wartość Status właściwości.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Aby zapoznać się z przykładem, zapoznaj się z WriteAsync(Byte[], Int32, Int32) przeciążeniem.For an example, see the WriteAsync(Byte[], Int32, Int32) overload.

Dotyczy

WriteAsync(Byte[], Int32, Int32)

Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przesuwa bieżącą pozycję w tym strumieniu o liczbę zapisanych bajtów.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

Parametry

buffer
Byte[]

Bufor, z którego mają zostać zapisane dane.The buffer to write data from.

offset
Int32

Przesunięcie bajtu (liczony od zera), buffer od którego należy rozpocząć kopiowanie bajtów do strumienia.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32

Maksymalna liczba bajtów do zapisania.The maximum number of bytes to write.

Zwraca

Task

Zadanie, które reprezentuje asynchroniczny zapis operacji.A task that represents the asynchronous write operation.

Atrybuty

Wyjątki

buffer to null.buffer is null.

offset lub count jest ujemna.offset or count is negative.

Suma offset i count jest większa niż długość buforu.The sum of offset and count is larger than the buffer length.

Strumień nie obsługuje zapisu.The stream does not support writing.

Strumień został usunięty.The stream has been disposed.

Strumień jest obecnie używany przez poprzednią operację zapisu.The stream is currently in use by a previous write operation.

Przykłady

Poniższy przykład pokazuje, jak zapisywać asynchronicznie w pliku.The following example shows how to write asynchronously to a file. W przykładzie zastosowano FileStream klasę, która pochodzi od Stream klasy.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

Uwagi

WriteAsyncMetoda umożliwia wykonywanie operacji We/Wy intensywnie obciążających zasoby bez blokowania wątku głównego.The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Ten wpływ na wydajność jest szczególnie istotny w aplikacji do sklepu Windows 8. x lub aplikacji klasycznej, w której czasochłonna operacja przesyłania strumieniowego może blokować wątek interfejsu użytkownika i sprawiać, że aplikacja wygląda tak, jakby nie działała.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. Metody asynchroniczne są używane w połączeniu z async await słowami kluczowymi i w Visual Basic i C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Użyj CanWrite właściwości, aby określić, czy bieżące wystąpienie obsługuje zapisywanie.Use the CanWrite property to determine whether the current instance supports writing.

Dotyczy