Stream.CopyToAsync Metod

Definition

Namnområde:: System.IO

Sammansättningar:: mscorlib.dll, System.IO.dll

Sammansättning:: mscorlib.dll

Sammansättning:: System.IO.dll

Sammansättning:: netstandard.dll

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström. Båda strömmarnas positioner avanceras av antalet kopierade byte.

Överlagringar

Name	Description
CopyToAsync(Stream, Int32, CancellationToken)	Läser asynkront byte från den aktuella strömmen och skriver dem till en annan dataström med en angiven buffertstorlek och annulleringstoken. Båda strömmarnas positioner avanceras av antalet kopierade byte.
CopyToAsync(Stream, CancellationToken)	Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström med hjälp av en angiven annulleringstoken. Båda strömmarnas positioner avanceras av antalet kopierade byte.
CopyToAsync(Stream)	Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström. Båda strömmarnas positioner avanceras av antalet kopierade byte.
CopyToAsync(Stream, Int32)	Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström med en angiven buffertstorlek. Båda strömmarnas positioner avanceras av antalet kopierade byte.

CopyToAsync(Stream, Int32, CancellationToken)

Läser asynkront byte från den aktuella strömmen och skriver dem till en annan dataström med en angiven buffertstorlek och annulleringstoken. Båda strömmarnas positioner avanceras av antalet kopierade byte.

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

Parametrar

destination: Stream

Den ström som innehållet i den aktuella strömmen ska kopieras till.

bufferSize: Int32

Buffertens storlek i byte. Det här värdet måste vara större än noll. Standardstorleken är 81920.

cancellationToken: CancellationToken

Token som ska övervakas för annulleringsbegäranden. Standardvärdet är None.

Returer

Task

En uppgift som representerar den asynkrona kopieringsåtgärden.

Attribut: ComVisibleAttribute

Undantag

ArgumentNullException

destination är null.

ArgumentOutOfRangeException

bufferSize är negativ eller noll.

ObjectDisposedException

Antingen tas den aktuella strömmen eller målströmmen bort.

NotSupportedException

Den aktuella strömmen stöder inte läsning eller så stöder inte målströmmen skrivning.

OperationCanceledException

Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.

Kommentarer

Med CopyToAsync metoden kan du utföra resursintensiva I/O-åtgärder utan att blockera huvudtråden. Den här prestandaöverväganden är särskilt viktig i en Windows 8.x Store-app eller skrivbordsapp där en tidskrävande strömåtgärd kan blockera användargränssnittstråden och få appen att se ut som om den inte fungerar. Asynkrona metoder används tillsammans med nyckelorden async och await i Visual Basic och C#.

Om åtgärden avbryts innan den slutförs innehåller Canceled den returnerade aktiviteten värdet för Status egenskapen.

Kopieringen börjar vid den aktuella positionen i den aktuella strömmen.

Ett exempel på kopiering mellan två strömmar finns i överlagringen CopyToAsync(Stream) .

Den här metoden lagrar i aktiviteten som returnerar alla undantag som inte används som metodens synkrona motsvarighet kan utlösa. Om ett undantag lagras i den returnerade aktiviteten utlöses undantaget när aktiviteten väntar. Användningsfel, till exempel ArgumentException, genereras fortfarande synkront. De lagrade undantagen finns i undantagen som genereras av CopyTo(Stream, Int32).

Gäller för

CopyToAsync(Stream, CancellationToken)

Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström med hjälp av en angiven annulleringstoken. Båda strömmarnas positioner avanceras av antalet kopierade byte.

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

Parametrar

destination: Stream

Den ström som innehållet i den aktuella strömmen ska kopieras till.

cancellationToken: CancellationToken

Token som ska övervakas för annulleringsbegäranden. Standardvärdet är None.

Returer

Task

En uppgift som representerar den asynkrona kopieringsåtgärden.

Undantag

OperationCanceledException

Annulleringstoken avbröts. Det här undantaget lagras i den returnerade aktiviteten.

Kommentarer

Om åtgärden avbryts innan den slutförs innehåller Canceled den returnerade aktiviteten värdet för Status egenskapen.

Kopieringen börjar vid den aktuella positionen i den aktuella strömmen.

Ett exempel på kopiering mellan två strömmar finns i överlagringen CopyToAsync(Stream) .

Gäller för

CopyToAsync(Stream)

Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström. Båda strömmarnas positioner avanceras av antalet kopierade byte.

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

Parametrar

destination: Stream

Den ström som innehållet i den aktuella strömmen ska kopieras till.

Returer

Task

En uppgift som representerar den asynkrona kopieringsåtgärden.

Attribut: ComVisibleAttribute

Undantag

ArgumentNullException

destination är null.

ObjectDisposedException

Antingen tas den aktuella strömmen eller målströmmen bort.

NotSupportedException

Den aktuella strömmen stöder inte läsning eller så stöder inte målströmmen skrivning.

Exempel

I följande exempel visas hur du använder två FileStream objekt för att asynkront kopiera filerna från en katalog till en annan. Klassen FileStream härleds från Stream klassen. Observera att Click händelsehanteraren för Button kontrollen är markerad med async modifieraren eftersom den anropar en asynkron metod

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

Kommentarer

Kopieringen börjar vid den aktuella positionen i den aktuella strömmen.

Gäller för

CopyToAsync(Stream, Int32)

Läser asynkront byte från den aktuella strömmen och skriver dem till en annan ström med en angiven buffertstorlek. Båda strömmarnas positioner avanceras av antalet kopierade byte.

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

Parametrar

destination: Stream

Den ström som innehållet i den aktuella strömmen ska kopieras till.

bufferSize: Int32

Buffertens storlek i byte. Det här värdet måste vara större än noll. Standardstorleken är 81920.

Returer

Task

En uppgift som representerar den asynkrona kopieringsåtgärden.

Attribut: ComVisibleAttribute

Undantag

ArgumentNullException

destination är null.

ArgumentOutOfRangeException

bufferSize är negativ eller noll.

ObjectDisposedException

Antingen tas den aktuella strömmen eller målströmmen bort.

NotSupportedException

Den aktuella strömmen stöder inte läsning eller så stöder inte målströmmen skrivning.

Kommentarer

Kopieringen börjar vid den aktuella positionen i den aktuella strömmen.

Ett exempel på kopiering mellan två strömmar finns i överlagringen CopyToAsync(Stream) .

Gäller för

Feedback

Var den här sidan till hjälp?