Stream.CopyToAsync Method

Definition

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream.

Overloads

CopyToAsync(Func<ReadOnlyMemory<Byte>,Object,CancellationToken,ValueTask>, Object, Int32, CancellationToken)
CopyToAsync(Stream, Int32, CancellationToken)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße und eines Abbruchtokens in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

CopyToAsync(Stream)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream.

CopyToAsync(Stream, Int32)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

CopyToAsync(Stream, CancellationToken)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung eines angegebenen Abbruchtokens in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

CopyToAsync(Func<ReadOnlyMemory<Byte>,Object,CancellationToken,ValueTask>, Object, Int32, CancellationToken)

public:
 virtual System::Threading::Tasks::Task ^ CopyToAsync(Func<ReadOnlyMemory<System::Byte>, System::Object ^, System::Threading::CancellationToken, System::Threading::Tasks::ValueTask> ^ callback, System::Object ^ state, int bufferSize, System::Threading::CancellationToken cancellationToken);
public virtual System.Threading.Tasks.Task CopyToAsync (Func<ReadOnlyMemory<byte>,object,System.Threading.CancellationToken,System.Threading.Tasks.ValueTask> callback, object state, int bufferSize, System.Threading.CancellationToken cancellationToken);
abstract member CopyToAsync : Func<ReadOnlyMemory<byte>, obj, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask> * obj * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CopyToAsync : Func<ReadOnlyMemory<byte>, obj, System.Threading.CancellationToken, System.Threading.Tasks.ValueTask> * obj * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function CopyToAsync (callback As Func(Of ReadOnlyMemory(Of Byte), Object, CancellationToken, ValueTask), state As Object, bufferSize As Integer, cancellationToken As CancellationToken) As Task

Parameters

state
Object
bufferSize
Int32
cancellationToken
CancellationToken

Returns

Task

CopyToAsync(Stream, Int32, CancellationToken)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße und eines Abbruchtokens in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

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);
[System.Runtime.InteropServices.ComVisible(false)]
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

Parameters

destination
Stream

Der Stream, in den der Inhalt des aktuellen Stream kopiert wird.The stream to which the contents of the current stream will be copied.

bufferSize
Int32

Die Größe des Cookies in Bytes.The size, in bytes, of the buffer. Dieser Wert muss größer als 0 sein.This value must be greater than zero. Die Standardgröße ist 81920.The default size is 81920.

cancellationToken
CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests. Standardwert: None.The default value is None.

Returns

Task

Eine Aufgabe, die den asynchronen Kopiervorgang darstellt.A task that represents the asynchronous copy operation.

Attributes

Exceptions

destination ist nulldestination is null.

buffersize ist negativ oder 0 (null).buffersize is negative or zero.

Entweder der aktuelle Stream oder der Zielstream wird freigegeben.Either the current stream or the destination stream is disposed.

Der aktuelle Stream unterstützt kein Lesen oder Zielstream unterstützt keine Schreibvorgänge.The current stream does not support reading, or the destination stream does not support writing.

Remarks

Die CopyToAsync-Methode ermöglicht es Ihnen, ressourcenintensive e/a-Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Die Async-Methoden werden in Verbindung mit den Schlüsselwörtern async und await in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen ist, enthält die zurückgegebene Aufgabe den Canceled Wert für die Status-Eigenschaft.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Der Kopiervorgang beginnt an der aktuellen Position im aktuellen Stream.Copying begins at the current position in the current stream.

Ein Beispiel für das Kopieren zwischen zwei Streams finden Sie in der CopyToAsync(Stream) Überladung.For an example of copying between two streams, see the CopyToAsync(Stream) overload.

CopyToAsync(Stream)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream.

public:
 System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination);
public System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination);
[System.Runtime.InteropServices.ComVisible(false)]
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

Parameters

destination
Stream

Der Stream, in den der Inhalt des aktuellen Stream kopiert wird.The stream to which the contents of the current stream will be copied.

Returns

Task

Eine Aufgabe, die den asynchronen Kopiervorgang darstellt.A task that represents the asynchronous copy operation.

Attributes

Exceptions

destination ist nulldestination is null.

Entweder der aktuelle Stream oder der Zielstream wird freigegeben.Either the current stream or the destination stream is disposed.

Der aktuelle Stream unterstützt kein Lesen oder Zielstream unterstützt keine Schreibvorgänge.The current stream does not support reading, or the destination stream does not support writing.

Examples

Im folgenden Beispiel wird veranschaulicht, wie zwei FileStream Objekten verwendet werden, um die Dateien asynchron aus einem Verzeichnis in ein anderes zu kopieren.The following example demonstrates how to use two FileStream objects to asynchronously copy the files from one directory to another. Die FileStream -Klasse wird aus der Stream -Klasse abgeleitet.The FileStream class derives from the Stream class. Beachten Sie, dass der Click Ereignishandler für das Button-Steuerelement mit dem async-Modifizierer markiert ist, da er eine asynchrone Methode aufruft.Notice that the Click event handler for the Button control is marked with the async modifier because it calls an asynchronous method

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

Remarks

Die CopyToAsync-Methode ermöglicht es Ihnen, ressourcenintensive e/a-Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Die Async-Methoden werden in Verbindung mit den Schlüsselwörtern async und await in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Der Kopiervorgang beginnt an der aktuellen Position im aktuellen Stream.Copying begins at the current position in the current stream.

CopyToAsync(Stream, Int32)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung einer angegebenen Puffergröße in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

public:
 System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, int bufferSize);
public System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, int bufferSize);
[System.Runtime.InteropServices.ComVisible(false)]
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

Parameters

destination
Stream

Der Stream, in den der Inhalt des aktuellen Stream kopiert wird.The stream to which the contents of the current stream will be copied.

bufferSize
Int32

Die Größe des Cookies in Bytes.The size, in bytes, of the buffer. Dieser Wert muss größer als 0 sein.This value must be greater than zero. Die Standardgröße ist 81920.The default size is 81920.

Returns

Task

Eine Aufgabe, die den asynchronen Kopiervorgang darstellt.A task that represents the asynchronous copy operation.

Attributes

Exceptions

destination ist nulldestination is null.

buffersize ist negativ oder 0 (null).buffersize is negative or zero.

Entweder der aktuelle Stream oder der Zielstream wird freigegeben.Either the current stream or the destination stream is disposed.

Der aktuelle Stream unterstützt kein Lesen oder Zielstream unterstützt keine Schreibvorgänge.The current stream does not support reading, or the destination stream does not support writing.

Remarks

Die CopyToAsync-Methode ermöglicht es Ihnen, ressourcenintensive e/a-Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Die Async-Methoden werden in Verbindung mit den Schlüsselwörtern async und await in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Der Kopiervorgang beginnt an der aktuellen Position im aktuellen Stream.Copying begins at the current position in the current stream.

Ein Beispiel für das Kopieren zwischen zwei Streams finden Sie in der CopyToAsync(Stream) Überladung.For an example of copying between two streams, see the CopyToAsync(Stream) overload.

CopyToAsync(Stream, CancellationToken)

Liest die Bytes asynchron aus dem aktuellen Stream und schreibt sie unter Verwendung eines angegebenen Abbruchtokens in einen anderen Stream.Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

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

Parameters

destination
Stream

Der Stream, in den der Inhalt des aktuellen Stream kopiert wird.The stream to which the contents of the current stream will be copied.

cancellationToken
CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests. Standardwert: None.The default value is None.

Returns

Task

Eine Aufgabe, die den asynchronen Kopiervorgang darstellt.A task that represents the asynchronous copy operation.

Remarks

Die CopyToAsync-Methode ermöglicht es Ihnen, ressourcenintensive e/a-Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Die Async-Methoden werden in Verbindung mit den Schlüsselwörtern async und await in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen ist, enthält die zurückgegebene Aufgabe den Canceled Wert für die Status-Eigenschaft.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Der Kopiervorgang beginnt an der aktuellen Position im aktuellen Stream.Copying begins at the current position in the current stream.

Ein Beispiel für das Kopieren zwischen zwei Streams finden Sie in der CopyToAsync(Stream) Überladung.For an example of copying between two streams, see the CopyToAsync(Stream) overload.

Applies to