WebClient.DownloadFileAsync 方法

参考

定义

命名空间:: System.Net

程序集:: System.Net.WebClient.dll

程序集:: System.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

将指定的资源作为异步操作下载到本地文件。这些方法不会阻止调用线程。

重载

DownloadFileAsync(Uri, String)	将具有指定 URI 的资源下载到本地文件。此方法不会阻止调用线程。
DownloadFileAsync(Uri, String, Object)	将具有指定 URI 的资源下载到本地文件。此方法不会阻止调用线程。

DownloadFileAsync(Uri, String)

Source:: WebClient.cs

Source:: WebClient.cs

Source:: WebClient.cs

将具有指定 URI 的资源下载到本地文件。此方法不会阻止调用线程。

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)

参数

address: Uri

要下载的资源的 URI。

fileName: String

要放置在本地计算机上的文件的名称。

例外

ArgumentNullException

address 参数 null。

-或-

fileName 参数 null。

WebException

组合 BaseAddress 和 address 形成的 URI 无效。

-或-

下载资源时出错。

InvalidOperationException

由 fileName 指定的本地文件由另一个线程使用。

注解

谨慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已过时，不应将其用于新开发。请改用 HttpClient。

此方法在 address 参数中指定的 URI 处下载资源。下载成功完成后，下载的文件将命名为本地计算机上的 fileName。使用从线程池自动分配的线程资源异步下载该文件。若要在文件可用时接收通知，请将事件处理程序添加到 DownloadFileCompleted 事件。

此方法不会在下载资源时阻止调用线程。若要在等待下载完成时阻止，请使用 DownloadFile 方法之一。

在 .NET Framework 和 .NET Core 1.0 中，可以通过调用 CancelAsync 方法取消尚未完成的异步操作。

如果 BaseAddress 属性不是空字符串（“”）且 address 未指定绝对 URI，address 必须是与 BaseAddress 相结合的相对 URI，以形成所请求数据的绝对 URI。如果 QueryString 属性不是空字符串，则会将其追加到 address。

此方法使用 RETR 命令下载 FTP 资源。对于 HTTP 资源，将使用 GET 方法。

注意

在应用程序中启用网络跟踪时，此成员将输出跟踪信息。有关详细信息，请参阅 .NET Framework中的网络跟踪。

在 ASP.NET 页中使用此方法时，如果页面所执行的帐户无权访问本地文件，则会收到错误。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。如果异常存储在返回的任务中，则等待任务时将引发该异常。使用异常（如 ArgumentException）仍同步引发。有关存储的异常，请参阅 DownloadFile(Uri, String)引发的异常。

适用于

DownloadFileAsync(Uri, String, Object)

Source:: WebClient.cs

Source:: WebClient.cs

Source:: WebClient.cs