FileStream.WriteAsync Méthode

Définition

Surcharges

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

Écrit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position actuelle dans ce flux du nombre d'octets écrits et surveille les demandes d'annulation.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)

Écrit de façon asynchrone une séquence d’octets depuis une zone de mémoire dans le flux de fichier actuel, avance la position actuelle dans ce flux de fichier du nombre d’octets écrits et supervise les demandes d’annulation.Asynchronously writes a sequence of bytes from a memory region to the current file stream, advances the current position within this file stream by the number of bytes written, and monitors cancellation requests.

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

Écrit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position actuelle dans ce flux du nombre d'octets écrits et surveille les demandes d'annulation.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:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task

Paramètres

buffer
Byte[]

Mémoire tampon dont sont issues les données à écrire.The buffer to write data from.

offset
Int32

Dans buffer, décalage d'octet de base zéro à partir duquel commencer la copie des octets dans le flux.The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count
Int32

Nombre maximal d'octets à écrire.The maximum number of bytes to write.

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests.

Retours

Task

Tâche qui représente l’opération d’écriture asynchrone.A task that represents the asynchronous write operation.

Attributs

Exceptions

buffer a la valeur null.buffer is null.

offset ou count est un nombre négatif.offset or count is negative.

La somme de offset et count est supérieure à la longueur de la mémoire tampon.The sum of offset and count is larger than the buffer length.

Le flux ne prend pas en charge l'écriture.The stream does not support writing.

Le flux a été supprimé.The stream has been disposed.

Le flux est actuellement utilisé par une opération d’écriture précédente.The stream is currently in use by a previous write operation.

Exemples

L’exemple suivant montre comment écrire de façon asynchrone dans un fichier.The following example shows how to write asynchronously to a file.

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

Remarques

La WriteAsync méthode vous permet d’effectuer des opérations de fichiers gourmandes en ressources sans bloquer le thread principal.The WriteAsync method enables you to perform resource-intensive file operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application de Windows 8. x Store ou une application de bureau où une opération de flux de temps peut bloquer le thread d’interface utilisateur et faire apparaître votre application comme si elle ne fonctionnait pas.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. Les méthodes Async sont utilisées conjointement avec les async await Mots clés et dans Visual Basic et C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez la CanWrite propriété pour déterminer si l’instance actuelle prend en charge l’écriture.Use the CanWrite property to determine whether the current instance supports writing.

Si l’opération est annulée avant d’être terminée, la tâche retournée contient la Canceled valeur de la Status propriété.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property. Si le handle du fichier est supprimé, la tâche retournée contient l' ObjectDisposedException exception dans la Exception propriété.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Exception property.

S’applique à

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Écrit de façon asynchrone une séquence d’octets depuis une zone de mémoire dans le flux de fichier actuel, avance la position actuelle dans ce flux de fichier du nombre d’octets écrits et supervise les demandes d’annulation.Asynchronously writes a sequence of bytes from a memory region to the current file stream, advances the current position within this file stream by the number of bytes written, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Paramètres

buffer
ReadOnlyMemory<Byte>

Région de la mémoire dont sont issues les données à écrire.The region of memory to write data from.

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests. La valeur par défaut est None.The default value is None.

Retours

ValueTask

Tâche qui représente l’opération d’écriture asynchrone.A task that represents the asynchronous write operation.

Remarques

La WriteAsync méthode vous permet d’effectuer des opérations d’e/s gourmandes en ressources sans bloquer le thread principal.The WriteAsync method lets you perform resource-intensive I/O operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application de Windows 8. x Store ou une application de bureau où une opération de flux de temps peut bloquer le thread d’interface utilisateur et faire apparaître votre application comme si elle ne fonctionnait pas.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. Les méthodes Async sont utilisées conjointement avec les async await Mots clés et dans Visual Basic et C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez la CanWrite propriété pour déterminer si l’instance actuelle prend en charge l’écriture.Use the CanWrite property to determine whether the current instance supports writing.

Si l’opération est annulée avant d’être terminée, la tâche retournée contient la TaskStatus.Canceled valeur de la Task.Status propriété.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

S’applique à