WebClient.DownloadFileAsync Methode

  • Referenz

Definition

Namespace:
System.Net
Assembly:
System.Net.WebClient.dll
Assembly:
System.dll
Assembly:
netstandard.dll

Lädt die angegebene Ressource als asynchronen Vorgang in eine lokale Datei herunter. Durch diese Methoden wird der aufrufende Thread nicht blockiert.

Überlädt

DownloadFileAsync(Uri, String)

Lädt die Ressource mit dem angegebenen URI in eine lokale Datei herunter. Durch diese Methode wird der aufrufende Thread nicht blockiert.
DownloadFileAsync(Uri, String, Object)

Lädt die Ressource mit dem angegebenen URI in eine lokale Datei herunter. Durch diese Methode wird der aufrufende Thread nicht blockiert.

DownloadFileAsync(Uri, String)

Lädt die Ressource mit dem angegebenen URI in eine lokale Datei herunter. Durch diese Methode wird der aufrufende Thread nicht blockiert.

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)

Parameter

address
Uri

Der herunterzuladende URI der Ressource.

fileName
String

Der Name der Datei, die auf dem lokalen Computer platziert werden soll.

Ausnahmen

ArgumentNullException

Der address-Parameter ist null.

- oder -

Der fileName-Parameter ist null.

WebException

Der durch Kombinieren von BaseAddress und address gebildete URI ist ungültig.

- oder -

Fehler beim Herunterladen der Ressource.

InvalidOperationException

Die von fileName angegebene lokale Datei wird von einem anderen Thread verwendet.

Hinweise

Diese Methode lädt die Ressource an dem im address Parameter angegebenen URI herunter. Wenn der Download erfolgreich abgeschlossen wurde, wird die heruntergeladene Datei auf dem lokalen Computer benannt fileName . Die Datei wird asynchron mit Threadressourcen heruntergeladen, die automatisch aus dem Threadpool zugeordnet werden. Um eine Benachrichtigung zu erhalten, wenn die Datei verfügbar ist, fügen Sie dem DownloadFileCompleted Ereignis einen Ereignishandler hinzu.

Diese Methode blockiert den aufrufenden Thread nicht, während die Ressource heruntergeladen wird. Verwenden Sie eine der DownloadFile Methoden, um zu blockieren, während sie auf den Abschluss des Downloads warten.

In .NET Framework und .NET Core 1.0 können Sie asynchrone Vorgänge abbrechen, die noch nicht abgeschlossen wurden, indem Sie die CancelAsync -Methode aufrufen.

Wenn die BaseAddress Eigenschaft keine leere Zeichenfolge ("") ist und address keinen absoluten URI angibt, muss es sich um einen relativen URI handeln, address der mit BaseAddress kombiniert wird, um den absoluten URI der angeforderten Daten zu bilden. Wenn die QueryString Eigenschaft keine leere Zeichenfolge ist, wird sie an addressangefügt.

Diese Methode verwendet den RETR-Befehl, um eine FTP-Ressource herunterzuladen. Für eine HTTP-Ressource wird die GET-Methode verwendet.

Hinweis

Dieser Member gibt Ablaufverfolgungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in der Anwendung aktivieren. Weitere Informationen finden Sie unter Netzwerkablaufverfolgung in .NET Framework.

Wenn Sie diese Methode auf einer ASP.NET Seite verwenden, erhalten Sie eine Fehlermeldung, wenn das Konto, unter dem die Seite ausgeführt wird, nicht über die Berechtigung für den Zugriff auf die lokale Datei verfügt.

Diese Methode speichert in der Aufgabe, die sie alle Nichtverwendungsausnahmen zurückgibt, die die synchrone Entsprechung der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Nutzungsausnahmen, z. B ArgumentException. , werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie unter die von ausgelösten DownloadFile(Uri, String)Ausnahmen.

Gilt für:

DownloadFileAsync(Uri, String, Object)

Lädt die Ressource mit dem angegebenen URI in eine lokale Datei herunter. Durch diese Methode wird der aufrufende Thread nicht blockiert.

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)

Parameter

address
Uri

Der herunterzuladende URI der Ressource.

fileName
String

Der Name der Datei, die auf dem lokalen Computer platziert werden soll.

userToken
Object

Ein benutzerdefiniertes Objekt, das bei Abschluss des asynchronen Vorgangs an die aufgerufene Methode übergeben wird.

Ausnahmen

ArgumentNullException

Der address-Parameter ist null.

- oder -

Der fileName-Parameter ist null.

WebException

Der durch Kombinieren von BaseAddress und address gebildete URI ist ungültig.

- oder -

Fehler beim Herunterladen der Ressource.

InvalidOperationException

Die von fileName angegebene lokale Datei wird von einem anderen Thread verwendet.

Hinweise

Diese Methode lädt die Ressource an dem im address Parameter angegebenen URI herunter. Wenn der Download erfolgreich abgeschlossen wurde, wird die heruntergeladene Datei auf dem lokalen Computer benannt fileName . Die Datei wird asynchron mit Threadressourcen heruntergeladen, die automatisch aus dem Threadpool zugeordnet werden. Um eine Benachrichtigung zu erhalten, wenn die Datei verfügbar ist, fügen Sie dem DownloadFileCompleted Ereignis einen Ereignishandler hinzu.

Diese Methode blockiert den aufrufenden Thread nicht, während die Ressource heruntergeladen wird. Verwenden Sie eine der DownloadFile Methoden, um zu blockieren, während sie auf den Abschluss des Downloads warten.

In .NET Framework und .NET Core 1.0 können Sie asynchrone Vorgänge abbrechen, die noch nicht abgeschlossen wurden, indem Sie die CancelAsync -Methode aufrufen.

Wenn die BaseAddress Eigenschaft keine leere Zeichenfolge ("") ist und address keinen absoluten URI angibt, muss es sich um einen relativen URI handeln, address der mit BaseAddress kombiniert wird, um den absoluten URI der angeforderten Daten zu bilden. Wenn die QueryString Eigenschaft keine leere Zeichenfolge ist, wird sie an addressangefügt.

Diese Methode verwendet den RETR-Befehl, um eine FTP-Ressource herunterzuladen. Für eine HTTP-Ressource wird die GET-Methode verwendet.

Hinweis

Dieser Member gibt Ablaufverfolgungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in der Anwendung aktivieren. Weitere Informationen finden Sie unter Netzwerkablaufverfolgung in .NET Framework.

Wenn Sie diese Methode auf einer ASP.NET Seite verwenden, erhalten Sie eine Fehlermeldung, wenn das Konto, unter dem die Seite ausgeführt wird, nicht über die Berechtigung für den Zugriff auf die lokale Datei verfügt.

Gilt für: