StreamWriter.WriteAsync Méthode

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Écrit de façon asynchrone des données dans le flux.

Surcharges

WriteAsync(Char)	Écrit de façon asynchrone un caractère dans le flux.
WriteAsync(String)	Écrit de façon asynchrone une chaîne dans le flux.
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	Écrit de façon asynchrone une zone de mémoire de caractères dans le flux.
WriteAsync(Char[], Int32, Int32)	Écrit de façon asynchrone un sous-tableau de caractères dans le flux.

WriteAsync(Char)

Source:

StreamWriter.cs

Écrit de façon asynchrone un caractère dans le flux.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(char value);

public override System.Threading.Tasks.Task WriteAsync (char value);

override this.WriteAsync : char -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (value As Char) As Task

Paramètres

value

Char

Caractère à écrire dans le flux.

Retours

Task

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

Exceptions

ObjectDisposedException

Le writer de flux est supprimé.

InvalidOperationException

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

Exemples

L’exemple suivant montre comment écrire un caractère unique (la lettre « a ») dans un fichier texte à l’aide de la WriteAsync(Char) méthode .

using System.IO;

namespace ConsoleApplication
{
    class Program1
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync('a');
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim oneLetter As Char = "a"
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(oneLetter)
        End Using
    End Sub
End Module

Remarques

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

WriteAsync(String)

Source:

StreamWriter.cs

Écrit de façon asynchrone une chaîne dans le flux.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(System::String ^ value);

public override System.Threading.Tasks.Task WriteAsync (string? value);

override this.WriteAsync : string -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (value As String) As Task

Paramètres

value

String

Chaîne à écrire dans le flux. Si value a la valeur null, rien n'est écrit.

Retours

Task

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

Exceptions

ObjectDisposedException

Le writer de flux est supprimé.

InvalidOperationException

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

Exemples

L’exemple suivant montre comment écrire une chaîne dans un fichier texte à l’aide de la WriteAsync(String) méthode .

using System.IO;

namespace ConsoleApplication
{
    class Program2
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync("Example text as string");
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync("Example text as string")
        End Using
    End Sub
End Module

Remarques

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

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

StreamWriter.cs

Écrit de façon asynchrone une zone de mémoire de caractères dans le flux.

public override System.Threading.Tasks.Task WriteAsync (ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As Task

Paramètres

buffer

ReadOnlyMemory<Char>

Zone de mémoire de caractères à écrire dans le flux.

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

OperationCanceledException

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

WriteAsync(Char[], Int32, Int32)

Source:

StreamWriter.cs

Écrit de façon asynchrone un sous-tableau de caractères dans le flux.

public:
 override System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);

override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (buffer As Char(), index As Integer, count As Integer) As Task

Paramètres

buffer

Char[]

Tableau de caractères contenant les données à écrire.

index

Int32

Position du caractère dans la mémoire où commencer la lecture des données.

count

Int32

Nombre maximal de caractères à écrire.

Retours

Task

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

Exceptions

ArgumentNullException

buffer a la valeur null.

ArgumentException

index plus count est supérieur à la longueur de la mémoire tampon.

ArgumentOutOfRangeException

index ou count est un nombre négatif.

ObjectDisposedException

Le writer de flux est supprimé.

InvalidOperationException

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

Exemples

L’exemple suivant montre comment écrire plusieurs caractères dans un fichier texte à l’aide de la WriteAsync(Char[], Int32, Int32) méthode .

using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program5
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            UnicodeEncoding ue = new UnicodeEncoding();
            char[] charsToAdd = ue.GetChars(ue.GetBytes("Example string"));
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim ue As UnicodeEncoding = New UnicodeEncoding()
        Dim charsToAdd() = ue.GetChars(ue.GetBytes("Example string"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)
        End Using
    End Sub
End Module

Remarques

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