WebClient.DownloadFileAsync Metoda

Definicja

Pobiera określony zasób do pliku lokalnego jako operację asynchroniczną. Te metody nie blokują wątku wywołującego.

Przeciążenia

DownloadFileAsync(Uri, String)

Pobiera do pliku lokalnego zasób o określonym identyfikatorze URI. Ta metoda nie blokuje wątku wywołującego.

DownloadFileAsync(Uri, String, Object)

Pobiera do pliku lokalnego zasób o określonym identyfikatorze URI. Ta metoda nie blokuje wątku wywołującego.

DownloadFileAsync(Uri, String)

Pobiera do pliku lokalnego zasób o określonym identyfikatorze URI. Ta metoda nie blokuje wątku wywołującego.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName);
public void DownloadFileAsync (Uri address, string fileName);
member this.DownloadFileAsync : Uri * string -> unit
Public Sub DownloadFileAsync (address As Uri, fileName As String)

Parametry

address
Uri

Identyfikator URI zasobu do pobrania.

fileName
String

Nazwa pliku do umieszczenia na komputerze lokalnym.

Wyjątki

Parametr address to null.

-lub-

Parametr fileName to null.

Identyfikator URI utworzony przez połączenie BaseAddress i address jest nieprawidłowy.

-lub-

Wystąpił błąd podczas pobierania zasobu.

Plik lokalny określony fileName przez jest używany przez inny wątek.

Uwagi

Ta metoda pobiera zasób pod identyfikatorem URI określonym przez parametr .address Po pomyślnym zakończeniu pobierania pobrany plik ma nazwę fileName na komputerze lokalnym. Plik jest pobierany asynchronicznie przy użyciu zasobów wątków, które są automatycznie przydzielane z puli wątków. Aby otrzymywać powiadomienie, gdy plik jest dostępny, dodaj procedurę obsługi zdarzeń do DownloadFileCompleted zdarzenia.

Ta metoda nie blokuje wątku wywołującego podczas pobierania zasobu. Aby zablokować podczas oczekiwania na ukończenie pobierania, użyj jednej z DownloadFile metod.

W .NET Framework i .NET Core 1.0 można anulować operacje asynchroniczne, które nie zostały ukończone, wywołując metodę CancelAsync .

BaseAddress Jeśli właściwość nie jest pustym ciągiem ("") i address nie określa bezwzględnego identyfikatora URI, musi być względnym identyfikatorem URI połączonym address z BaseAddress w celu utworzenia bezwzględnego identyfikatora URI żądanych danych. QueryString Jeśli właściwość nie jest pustym ciągiem, jest dołączana do addresselementu .

Ta metoda używa polecenia RETR do pobrania zasobu FTP. W przypadku zasobu HTTP jest używana metoda GET.

Uwaga

Ten element członkowski generuje informacje ze śledzenia pod warunkiem włączenia funkcji śledzenia sieci w aplikacji. Aby uzyskać więcej informacji, zobacz Śledzenie sieci w .NET Framework.

W przypadku korzystania z tej metody na stronie ASP.NET zostanie wyświetlony błąd, jeśli konto wykonywane na stronie nie ma uprawnień dostępu do pliku lokalnego.

Dotyczy

DownloadFileAsync(Uri, String, Object)

Pobiera do pliku lokalnego zasób o określonym identyfikatorze URI. Ta metoda nie blokuje wątku wywołującego.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName, System::Object ^ userToken);
public void DownloadFileAsync (Uri address, string fileName, object? userToken);
public void DownloadFileAsync (Uri address, string fileName, object userToken);
member this.DownloadFileAsync : Uri * string * obj -> unit
Public Sub DownloadFileAsync (address As Uri, fileName As String, userToken As Object)

Parametry

address
Uri

Identyfikator URI zasobu do pobrania.

fileName
String

Nazwa pliku do umieszczenia na komputerze lokalnym.

userToken
Object

Obiekt zdefiniowany przez użytkownika, który jest przekazywany do metody wywoływanej po zakończeniu operacji asynchronicznej.

Wyjątki

Parametr address to null.

-lub-

Parametr fileName to null.

Identyfikator URI utworzony przez połączenie BaseAddress i address jest nieprawidłowy.

-lub-

Wystąpił błąd podczas pobierania zasobu.

Plik lokalny określony fileName przez jest używany przez inny wątek.

Uwagi

Ta metoda pobiera zasób pod identyfikatorem URI określonym przez parametr .address Po pomyślnym zakończeniu pobierania pobrany plik ma nazwę fileName na komputerze lokalnym. Plik jest pobierany asynchronicznie przy użyciu zasobów wątków, które są automatycznie przydzielane z puli wątków. Aby otrzymywać powiadomienie, gdy plik jest dostępny, dodaj procedurę obsługi zdarzeń do DownloadFileCompleted zdarzenia.

Ta metoda nie blokuje wątku wywołującego podczas pobierania zasobu. Aby zablokować podczas oczekiwania na ukończenie pobierania, użyj jednej z DownloadFile metod.

W .NET Framework i .NET Core 1.0 można anulować operacje asynchroniczne, które nie zostały ukończone, wywołując metodę CancelAsync .

BaseAddress Jeśli właściwość nie jest pustym ciągiem ("") i address nie określa bezwzględnego identyfikatora URI, musi być względnym identyfikatorem URI połączonym address z BaseAddress w celu utworzenia bezwzględnego identyfikatora URI żądanych danych. QueryString Jeśli właściwość nie jest pustym ciągiem, jest dołączana do addresselementu .

Ta metoda używa polecenia RETR do pobrania zasobu FTP. W przypadku zasobu HTTP jest używana metoda GET.

Uwaga

Ten element członkowski generuje informacje ze śledzenia pod warunkiem włączenia funkcji śledzenia sieci w aplikacji. Aby uzyskać więcej informacji, zobacz Śledzenie sieci w .NET Framework.

W przypadku korzystania z tej metody na stronie ASP.NET zostanie wyświetlony błąd, jeśli konto wykonywane na stronie nie ma uprawnień dostępu do pliku lokalnego.

Dotyczy