Stream.CopyToAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

Přetížení

CopyToAsync(Stream, Int32, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti a tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.
CopyToAsync(Stream, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.
CopyToAsync(Stream)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.
CopyToAsync(Stream, Int32)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

CopyToAsync(Stream, Int32, CancellationToken)

Zdroj:

Stream.cs

Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti a tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

public:
 virtual System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, int bufferSize, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, int bufferSize, System.Threading.CancellationToken cancellationToken);

abstract member CopyToAsync : System.IO.Stream * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CopyToAsync : System.IO.Stream * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CopyToAsync (destination As Stream, bufferSize As Integer, cancellationToken As CancellationToken) As Task

Parametry

destination

Stream

Datový proud, do kterého se zkopíruje obsah aktuálního datového proudu.

bufferSize

Int32

Velikost vyrovnávací paměti v bajtech. Tato hodnota musí být větší než nula. Výchozí velikost je 81920.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

Task

Úloha, která představuje asynchronní operaci kopírování.

Výjimky

ArgumentNullException

destination je null.

ArgumentOutOfRangeException

buffersize je záporná nebo nulová.

ObjectDisposedException

Buď aktuální datový proud, nebo cílový datový proud je odstraněn.

NotSupportedException

Aktuální datový proud nepodporuje čtení nebo cílový datový proud nepodporuje zápis.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Metoda CopyToAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat Canceled hodnotu vlastnosti Status .

Kopírování začíná na aktuální pozici v aktuálním datovém proudu.

Příklad kopírování mezi dvěma datovými proudy najdete v tématu přetížení CopyToAsync(Stream) .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem CopyTo(Stream, Int32).

CopyToAsync(Stream, CancellationToken)

Zdroj:

Stream.cs

Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

public:
 System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken);

member this.CopyToAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CopyToAsync (destination As Stream, cancellationToken As CancellationToken) As Task

Parametry

destination

Stream

Datový proud, do kterého se zkopíruje obsah aktuálního datového proudu.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

Task

Úloha, která představuje asynchronní operaci kopírování.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Metoda CopyToAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat Canceled hodnotu vlastnosti Status .

Kopírování začíná na aktuální pozici v aktuálním datovém proudu.

Příklad kopírování mezi dvěma datovými proudy najdete v tématu přetížení CopyToAsync(Stream) .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem CopyTo(Stream).

CopyToAsync(Stream)

Zdroj:

Stream.cs

Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

public:
 System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination);

public System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination);

member this.CopyToAsync : System.IO.Stream -> System.Threading.Tasks.Task

Public Function CopyToAsync (destination As Stream) As Task

Parametry

destination

Stream

Datový proud, do kterého se zkopíruje obsah aktuálního datového proudu.

Návraty

Task

Úloha, která představuje asynchronní operaci kopírování.

Výjimky

ArgumentNullException

destination je null.

ObjectDisposedException

Buď aktuální datový proud, nebo cílový datový proud je odstraněn.

NotSupportedException

Aktuální datový proud nepodporuje čtení nebo cílový datový proud nepodporuje zápis.

Příklady

Následující příklad ukazuje, jak použít dva FileStream objekty k asynchronnímu kopírování souborů z jednoho adresáře do jiného. Třída je FileStream odvozena z Stream třídy. Všimněte si, že obslužná Click rutina Button události ovládacího prvku je označena modifikátorem async , protože volá asynchronní metodu.

using System;
using System.Threading.Tasks;
using System.Windows;
using System.IO;

namespace WpfApplication
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string StartDirectory = @"c:\Users\exampleuser\start";
            string EndDirectory = @"c:\Users\exampleuser\end";

            foreach (string filename in Directory.EnumerateFiles(StartDirectory))
            {
                using (FileStream SourceStream = File.Open(filename, FileMode.Open))
                {
                    using (FileStream DestinationStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf('\\'))))
                    {
                        await SourceStream.CopyToAsync(DestinationStream);
                    }
                }
            }
        }
    }
}

Imports System.IO

Class MainWindow

    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim StartDirectory As String = "c:\Users\exampleuser\start"
        Dim EndDirectory As String = "c:\Users\exampleuser\end"

        For Each filename As String In Directory.EnumerateFiles(StartDirectory)
            Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
                Using DestinationStream As FileStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf("\"c)))
                    Await SourceStream.CopyToAsync(DestinationStream)
                End Using

            End Using
        Next
    End Sub

End Class

Poznámky

Metoda CopyToAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

Kopírování začíná na aktuální pozici v aktuálním datovém proudu.

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem CopyTo(Stream).

CopyToAsync(Stream, Int32)

Zdroj:

Stream.cs

Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů.

public:
 System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, int bufferSize);

public System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, int bufferSize);

member this.CopyToAsync : System.IO.Stream * int -> System.Threading.Tasks.Task

Public Function CopyToAsync (destination As Stream, bufferSize As Integer) As Task

Parametry

destination

Stream

Datový proud, do kterého se zkopíruje obsah aktuálního datového proudu.

bufferSize

Int32

Velikost vyrovnávací paměti v bajtech. Tato hodnota musí být větší než nula. Výchozí velikost je 81920.

Návraty

Task

Úloha, která představuje asynchronní operaci kopírování.

Výjimky

ArgumentNullException

destination je null.

ArgumentOutOfRangeException

buffersize je záporná nebo nulová.

ObjectDisposedException

Buď aktuální datový proud, nebo cílový datový proud je odstraněn.

NotSupportedException

Aktuální datový proud nepodporuje čtení nebo cílový datový proud nepodporuje zápis.

Poznámky

Metoda CopyToAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v aplikaci Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

Kopírování začíná na aktuální pozici v aktuálním datovém proudu.

Příklad kopírování mezi dvěma datovými proudy najdete v tématu přetížení CopyToAsync(Stream) .

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem CopyTo(Stream, Int32).