CopyToAsync Method (Stream)
Collapse the table of content
Expand the table of content

Stream.CopyToAsync Method (Stream)

.NET Framework (current version)
 

Asynchronously reads the bytes from the current stream and writes them to another stream.

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)

<ComVisibleAttribute(False)>
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)>
Public Function CopyToAsync (
	destination As Stream
) As Task

Parameters

destination
Type: System.IO.Stream

The stream to which the contents of the current stream will be copied.

Return Value

Type: System.Threading.Tasks.Task

A task that represents the asynchronous copy operation.

Exception Condition
ArgumentNullException

destination is null.

ObjectDisposedException

Either the current stream or the destination stream is disposed.

NotSupportedException

The current stream does not support reading, or the destination stream does not support writing.

The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Copying begins at the current position in the current stream.

The following example demonstrates how to use two FileStream objects to asynchronously copy the files from one directory to another. The FileStream class derives from the Stream class. Notice that the Click event handler for the Button control is marked with the async modifier because it calls an asynchronous method

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft