Stream.WriteAsync Méthode

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Écrit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position actuelle dans le flux du nombre d'octets écrits.

Surcharges

WriteAsync(ReadOnlyMemory<Byte>, 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.
WriteAsync(Byte[], Int32, Int32)	Écrit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position actuelle dans le flux du nombre d'octets écrits.
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.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Source:

Stream.cs

É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.

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

Paramètres

buffer

ReadOnlyMemory<Byte>

Région de la mémoire dont sont issues les données à écrire.

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation. La valeur par défaut est None.

Retours

ValueTask

Tâche qui représente l’opération d’écriture asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

La WriteAsync méthode vous permet d’effectuer des opérations d’E/S gourmandes en ressources sans bloquer le thread main. Cette considération de performance est particulièrement importante dans une application Windows 8.x Store ou une application de bureau où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas. Les méthodes asynchrones sont utilisées conjointement avec les async mots clés et await dans Visual Basic et C#.

Utilisez la CanWrite propriété pour déterminer si le instance actuel prend en charge l’écriture.

Si l’opération est annulée avant sa fin, la tâche retournée contient la Canceled valeur de la Status propriété .

Pour obtenir un exemple, consultez la WriteAsync(Byte[], Int32, Int32) surcharge.

WriteAsync(Byte[], Int32, Int32)

Source:

Stream.cs

Écrit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position actuelle dans le flux du nombre d'octets écrits.

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);

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

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

Paramètres

buffer

Byte[]

Mémoire tampon dont sont issues les données à écrire.

offset

Int32

Dans buffer, décalage d'octet de base zéro à partir duquel commencer la copie des octets dans le flux.

count

Int32

Nombre maximal d'octets à écrire.

Retours

Task

Tâche qui représente l’opération d’écriture asynchrone.

Exceptions

ArgumentNullException

buffer a la valeur null.

ArgumentOutOfRangeException

offset ou count est un nombre négatif.

ArgumentException

La somme de offset et count est supérieure à la longueur de la mémoire tampon.

NotSupportedException

Le flux ne prend pas en charge l'écriture.

ObjectDisposedException

Le flux a été supprimé.

InvalidOperationException

Le flux est actuellement utilisé par une opération d’écriture précédente.

Exemples

L’exemple suivant montre comment écrire de manière asynchrone dans un fichier. L’exemple utilise la FileStream classe , qui dérive de la Stream classe .

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 d’E/S gourmandes en ressources sans bloquer le thread main. Cette considération de performance est particulièrement importante dans une application Windows 8.x Store ou une application de bureau où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas. Les méthodes asynchrones sont utilisées conjointement avec les async mots clés et await dans Visual Basic et C#.

Utilisez la CanWrite propriété pour déterminer si le instance actuel prend en charge l’écriture.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par Write(Byte[], Int32, Int32).

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

Source:

Stream.cs

É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.

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);

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

Paramètres

buffer

Byte[]

Mémoire tampon dont sont issues les données à écrire.

offset

Int32

Dans buffer, décalage d'octet de base zéro à partir duquel commencer la copie des octets dans le flux.

count

Int32

Nombre maximal d'octets à écrire.

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation. La valeur par défaut est None.

Retours

Task

Tâche qui représente l’opération d’écriture asynchrone.

Exceptions

ArgumentNullException

buffer a la valeur null.

ArgumentOutOfRangeException

offset ou count est un nombre négatif.

ArgumentException

La somme de offset et count est supérieure à la longueur de la mémoire tampon.

NotSupportedException

Le flux ne prend pas en charge l'écriture.

ObjectDisposedException

Le flux a été supprimé.

InvalidOperationException

Le flux est actuellement utilisé par une opération d’écriture précédente.

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

La WriteAsync méthode vous permet d’effectuer des opérations d’E/S gourmandes en ressources sans bloquer le thread main. Cette considération de performance est particulièrement importante dans une application Windows 8.x Store ou une application de bureau où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas. Les méthodes asynchrones sont utilisées conjointement avec les async mots clés et await dans Visual Basic et C#.

Utilisez la CanWrite propriété pour déterminer si le instance actuel prend en charge l’écriture.

Si l’opération est annulée avant sa fin, la tâche retournée contient la Canceled valeur de la Status propriété .

Pour obtenir un exemple, consultez la WriteAsync(Byte[], Int32, Int32) surcharge.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par Write(Byte[], Int32, Int32).

Voir aussi

• Annulation