Stream.WriteAsync Metódus

Definíció

Névtér:

System.IO

Szerelvények:

netstandard.dll, System.Runtime.dll

Aszinkron módon bájtok sorozatát írja az aktuális adatfolyamba, és a megírt bájtok számával előrelépteti a stream aktuális pozícióját.

Túlterhelések

Name	Description
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Aszinkron módon bájtok sorozatát írja az aktuális streambe, az aktuális pozíciót a streamen belül a megírt bájtok számával lépteti előre, és figyeli a lemondási kérelmeket.
WriteAsync(Byte[], Int32, Int32)	Aszinkron módon bájtok sorozatát írja az aktuális adatfolyamba, és a megírt bájtok számával előrelépteti a stream aktuális pozícióját.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Aszinkron módon bájtok sorozatát írja az aktuális streambe, az aktuális pozíciót a streamen belül a megírt bájtok számával lépteti előre, és figyeli a lemondási kérelmeket.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Forrás:

Stream.cs

Aszinkron módon bájtok sorozatát írja az aktuális streambe, az aktuális pozíciót a streamen belül a megírt bájtok számával lépteti előre, és figyeli a lemondási kérelmeket.

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éterek

buffer

ReadOnlyMemory<Byte>

Az adatok írásához használandó memóriaterület.

cancellationToken

CancellationToken

A lemondási kérelmek figyelésére szolgáló jogkivonat. Az alapértelmezett érték a None.

Válaszok

ValueTask

Az aszinkron írási műveletet képviselő feladat.

Kivételek

OperationCanceledException

A lemondási jogkivonat megszakadt. Ezt a kivételt a rendszer a visszaadott tevékenységben tárolja.

Megjegyzések

A WriteAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanWrite A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az írást.

Ha a művelet befejeződése előtt megszakítja a műveletet, a visszaadott tevékenység tartalmazza a CanceledStatus tulajdonság értékét.

Például tekintse meg a túlterhelést WriteAsync(Byte[], Int32, Int32) .

WriteAsync(Byte[], Int32, Int32)

Forrás:

Stream.cs

Aszinkron módon bájtok sorozatát írja az aktuális adatfolyamba, és a megírt bájtok számával előrelépteti a stream aktuális pozícióját.

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éterek

buffer

Byte[]

A puffer, amelyből adatokat írhat.

offset

Int32

A nullaalapú bájteltolás buffer , amelyből a bájtok másolása megkezdhető a streambe.

count

Int32

Az írható bájtok maximális száma.

Válaszok

Task

Az aszinkron írási műveletet képviselő feladat.

Kivételek

ArgumentNullException

buffer az null.

ArgumentOutOfRangeException

offset vagy count negatív.

ArgumentException

A puffer hosszánál nagyobb és offset nagyobb összegcount.

NotSupportedException

A stream nem támogatja az írást.

ObjectDisposedException

A stream el lett dobva.

InvalidOperationException

A streamet jelenleg egy korábbi írási művelet használja.

Példák

Az alábbi példa bemutatja, hogyan írhat aszinkron módon egy fájlba. A példa az FileStream osztályból Stream származó osztályt használja.

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

Megjegyzések

A WriteAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanWrite A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az írást.

Ez a metódus a feladatban tárolja az összes olyan nem használati kivételt, amelyet a metódus szinkron megfelelője tud dobni. Ha egy kivételt tárol a visszaadott tevékenységben, akkor a rendszer akkor küldi el a kivételt, amikor a feladatra vár. A használati kivételek(például ArgumentException) továbbra is szinkron módon jelennek meg. A tárolt kivételekről lásd a következő által Write(Byte[], Int32, Int32)kiadott kivételeket: .

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

Forrás:

Stream.cs

Aszinkron módon bájtok sorozatát írja az aktuális streambe, az aktuális pozíciót a streamen belül a megírt bájtok számával lépteti előre, és figyeli a lemondási kérelmeket.

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éterek

buffer

Byte[]

A puffer, amelyből adatokat írhat.

offset

Int32

A nullaalapú bájteltolás buffer , amelyből a bájtok másolása megkezdhető a streambe.

count

Int32

Az írható bájtok maximális száma.

cancellationToken

CancellationToken

A lemondási kérelmek figyelésére szolgáló jogkivonat. Az alapértelmezett érték a None.

Válaszok

Task

Az aszinkron írási műveletet képviselő feladat.

Kivételek

ArgumentNullException

buffer az null.

ArgumentOutOfRangeException

offset vagy count negatív.

ArgumentException

A puffer hosszánál nagyobb és offset nagyobb összegcount.

NotSupportedException

A stream nem támogatja az írást.

ObjectDisposedException

A stream el lett dobva.

InvalidOperationException

A streamet jelenleg egy korábbi írási művelet használja.

OperationCanceledException

A lemondási jogkivonat megszakadt. Ezt a kivételt a rendszer a visszaadott tevékenységben tárolja.

Megjegyzések

A WriteAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanWrite A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az írást.

Ha a művelet befejeződése előtt megszakítja a műveletet, a visszaadott tevékenység tartalmazza a CanceledStatus tulajdonság értékét.

Például tekintse meg a túlterhelést WriteAsync(Byte[], Int32, Int32) .

Ez a metódus a feladatban tárolja az összes olyan nem használati kivételt, amelyet a metódus szinkron megfelelője tud dobni. Ha egy kivételt tárol a visszaadott tevékenységben, akkor a rendszer akkor küldi el a kivételt, amikor a feladatra vár. A használati kivételek(például ArgumentException) továbbra is szinkron módon jelennek meg. A tárolt kivételekről lásd a következő által Write(Byte[], Int32, Int32)kiadott kivételeket: .

Lásd még

• lemondás