Stream.CopyToAsync Stream.CopyToAsync Stream.CopyToAsync Stream.CopyToAsync Method

定義

現在のストリームからすべてのバイトを非同期に読み取り、別のストリームに書き込みます。Asynchronously reads the bytes from the current stream and writes them to another stream.

オーバーロード

CopyToAsync(Stream, Int32, CancellationToken) CopyToAsync(Stream, Int32, CancellationToken) CopyToAsync(Stream, Int32, CancellationToken)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、指定されたバッファー サイズとキャンセル トークンを使用して、別のストリームに書き込みます。Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.

CopyToAsync(Stream, CancellationToken) CopyToAsync(Stream, CancellationToken) CopyToAsync(Stream, CancellationToken)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、指定されたキャンセル トークンを使用して、別のストリームに書き込みます。Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

CopyToAsync(Stream) CopyToAsync(Stream) CopyToAsync(Stream) CopyToAsync(Stream)

現在のストリームからすべてのバイトを非同期に読み取り、別のストリームに書き込みます。Asynchronously reads the bytes from the current stream and writes them to another stream.

CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

CopyToAsync(Stream, Int32, CancellationToken) CopyToAsync(Stream, Int32, CancellationToken) CopyToAsync(Stream, Int32, CancellationToken)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、指定されたバッファー サイズとキャンセル トークンを使用して、別のストリームに書き込みます。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);
[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

パラメーター

destination
Stream Stream Stream Stream

現在のストリームの内容のコピー先のストリーム。The stream to which the contents of the current stream will be copied.

bufferSize
Int32 Int32 Int32 Int32

バッファーのサイズ (バイト数)。The size, in bytes, of the buffer. これは、0 より大きい値である必要があります。This value must be greater than zero. 既定のサイズは 81920 です。The default size is 81920.

cancellationToken
CancellationToken CancellationToken CancellationToken CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

非同期のコピー操作を表すタスク。A task that represents the asynchronous copy operation.

例外

buffersize が負の値またはゼロです。buffersize is negative or zero.

現在のストリームまたはコピー先ストリームは破棄されます。Either the current stream or the destination stream is disposed.

現在のストリームが読み取りをサポートしていないか、コピー先のストリームが書き込みをサポートしていません。The current stream does not support reading, or the destination stream does not support writing.

注釈

メソッドCopyToAsyncを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストア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. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

操作が完了前にキャンセルされた場合、返されたCanceledタスクにはStatusプロパティの値が含まれます。If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

コピーは、現在のストリームの現在位置から開始します。Copying begins at the current position in the current stream.

2つのストリーム間でコピーする例についCopyToAsync(Stream)ては、「オーバーロード」を参照してください。For an example of copying between two streams, see the CopyToAsync(Stream) overload.

CopyToAsync(Stream, CancellationToken) CopyToAsync(Stream, CancellationToken) CopyToAsync(Stream, CancellationToken)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、指定されたキャンセル トークンを使用して、別のストリームに書き込みます。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

パラメーター

destination
Stream Stream Stream Stream

現在のストリームの内容のコピー先のストリーム。The stream to which the contents of the current stream will be copied.

cancellationToken
CancellationToken CancellationToken CancellationToken CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

非同期のコピー操作を表すタスク。A task that represents the asynchronous copy operation.

注釈

メソッドCopyToAsyncを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストア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. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

操作が完了前にキャンセルされた場合、返されたCanceledタスクにはStatusプロパティの値が含まれます。If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

コピーは、現在のストリームの現在位置から開始します。Copying begins at the current position in the current stream.

2つのストリーム間でコピーする例についCopyToAsync(Stream)ては、「オーバーロード」を参照してください。For an example of copying between two streams, see the CopyToAsync(Stream) overload.

CopyToAsync(Stream) CopyToAsync(Stream) CopyToAsync(Stream) CopyToAsync(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);
[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

パラメーター

destination
Stream Stream Stream Stream

現在のストリームの内容のコピー先のストリーム。The stream to which the contents of the current stream will be copied.

戻り値

非同期のコピー操作を表すタスク。A task that represents the asynchronous copy operation.

例外

現在のストリームまたはコピー先ストリームは破棄されます。Either the current stream or the destination stream is disposed.

現在のストリームが読み取りをサポートしていないか、コピー先のストリームが書き込みをサポートしていません。The current stream does not support reading, or the destination stream does not support writing.

次の例では、2つFileStreamのオブジェクトを使用して、あるディレクトリから別のディレクトリにファイルを非同期的にコピーする方法を示します。The following example demonstrates how to use two FileStream objects to asynchronously copy the files from one directory to another. FileStream クラスは Stream クラスから派生します。The FileStream class derives from the Stream class. コントロールのイベントハンドラーは、非同期メソッドを呼び出すためasync 、修飾子でマークされていることに注意してください。 Click ButtonNotice 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

注釈

メソッドCopyToAsyncを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストア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. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。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.

CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32) CopyToAsync(Stream, Int32)

指定されたバッファー サイズを使用して、現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。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);
[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

パラメーター

destination
Stream Stream Stream Stream

現在のストリームの内容のコピー先のストリーム。The stream to which the contents of the current stream will be copied.

bufferSize
Int32 Int32 Int32 Int32

バッファーのサイズ (バイト数)。The size, in bytes, of the buffer. これは、0 より大きい値である必要があります。This value must be greater than zero. 既定のサイズは 81920 です。The default size is 81920.

戻り値

非同期のコピー操作を表すタスク。A task that represents the asynchronous copy operation.

例外

buffersize が負の値またはゼロです。buffersize is negative or zero.

現在のストリームまたはコピー先ストリームは破棄されます。Either the current stream or the destination stream is disposed.

現在のストリームが読み取りをサポートしていないか、コピー先のストリームが書き込みをサポートしていません。The current stream does not support reading, or the destination stream does not support writing.

注釈

メソッドCopyToAsyncを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたはデスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストア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. 非同期メソッドは、Visual Basic およびasync await C#のキーワードと共に使用されます。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.

2つのストリーム間でコピーする例についCopyToAsync(Stream)ては、「オーバーロード」を参照してください。For an example of copying between two streams, see the CopyToAsync(Stream) overload.

適用対象