Stream.CopyToAsync Método

Definição

Namespace:

System.IO

Assembly:

System.IO.dll

Assembly:

System.Runtime.dll

Assembly:

netstandard.dll

Assembly:

mscorlib.dll

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo.

Sobrecargas

CopyToAsync(Stream, Int32, CancellationToken)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.
CopyToAsync(Stream, CancellationToken)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um token de cancelamento especificado.
CopyToAsync(Stream, Int32)	Lê de maneira assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.
CopyToAsync(Stream)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo.

CopyToAsync(Stream, Int32, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.

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

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

Parâmetros

destination

Stream

O fluxo para o qual o conteúdo do fluxo atual será copiado.

bufferSize

Int32

O tamanho do buffer, em bytes. Esse valor deve ser maior que zero. O tamanho padrão é 81.920.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

Uma tarefa que representa a operação de cópia assíncrona.

Atributos

ComVisibleAttribute

Exceções

ArgumentNullException

destination é null.

ArgumentOutOfRangeException

buffersize é negativo ou zero.

ObjectDisposedException

O fluxo atual ou o fluxo de destino é descartado.

NotSupportedException

O fluxo atual não dá suporte à leitura ou o fluxo de destino não dá suporte à gravação.

Comentários

O método permite que você execute operações de E/S com uso intensivo CopyToAsync de recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows 8.x Store ou aplicativo da área de trabalho em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer com que seu aplicativo apareça como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e em Visual Basic e await C#.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá Canceled o valor da propriedade Status .

A cópia começa na posição atual no fluxo atual.

Para ver um exemplo de cópia entre dois fluxos, consulte a CopyToAsync(Stream) sobrecarga.

CopyToAsync(Stream, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um token de cancelamento especificado.

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

Parâmetros

destination

Stream

O fluxo para o qual o conteúdo do fluxo atual será copiado.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

Uma tarefa que representa a operação de cópia assíncrona.

Comentários

O método permite que você execute operações de E/S com uso intensivo CopyToAsync de recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows 8.x Store ou aplicativo da área de trabalho em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer com que seu aplicativo apareça como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e em Visual Basic e await C#.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá Canceled o valor da propriedade Status .

A cópia começa na posição atual no fluxo atual.

Para ver um exemplo de cópia entre dois fluxos, consulte a CopyToAsync(Stream) sobrecarga.

CopyToAsync(Stream, Int32)

Lê de maneira assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.

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

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.CopyToAsync : System.IO.Stream * int -> System.Threading.Tasks.Task

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

Parâmetros

destination

Stream

O fluxo para o qual o conteúdo do fluxo atual será copiado.

bufferSize

Int32

O tamanho do buffer, em bytes. Esse valor deve ser maior que zero. O tamanho padrão é 81.920.

Retornos

Task

Uma tarefa que representa a operação de cópia assíncrona.

Atributos

ComVisibleAttribute

Exceções

ArgumentNullException

destination é null.

ArgumentOutOfRangeException

buffersize é negativo ou zero.

ObjectDisposedException

O fluxo atual ou o fluxo de destino é descartado.

NotSupportedException

O fluxo atual não dá suporte à leitura ou o fluxo de destino não dá suporte à gravação.

Comentários

O método permite que você execute operações de E/S com uso intensivo CopyToAsync de recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows 8.x Store ou aplicativo da área de trabalho em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer com que seu aplicativo apareça como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e em Visual Basic e await C#.

A cópia começa na posição atual no fluxo atual.

Para ver um exemplo de cópia entre dois fluxos, consulte a CopyToAsync(Stream) sobrecarga.

CopyToAsync(Stream)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo.

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

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.CopyToAsync : System.IO.Stream -> System.Threading.Tasks.Task

Public Function CopyToAsync (destination As Stream) As Task

Parâmetros

destination

Stream

O fluxo para o qual o conteúdo do fluxo atual será copiado.

Retornos

Task

Uma tarefa que representa a operação de cópia assíncrona.

Atributos

ComVisibleAttribute

Exceções

ArgumentNullException

destination é null.

ObjectDisposedException

O fluxo atual ou o fluxo de destino é descartado.

NotSupportedException

O fluxo atual não dá suporte à leitura ou o fluxo de destino não dá suporte à gravação.

Exemplos

O exemplo a seguir demonstra como usar dois objetos para copiar de forma FileStream assíncrona os arquivos de um diretório para outro. A FileStream classe deriva da classe Stream . Observe que o manipulador de eventos para o controle é marcado com o Click Button async modificador porque ele chama um método assíncrono

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

Comentários

O método permite que você execute operações de E/S com uso intensivo CopyToAsync de recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows 8.x Store ou aplicativo da área de trabalho em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer com que seu aplicativo apareça como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e em Visual Basic e await C#.

A cópia começa na posição atual no fluxo atual.