WebClient.DownloadFileTaskAsync 方法

定义

命名空间:

System.Net

程序集:

System.Net.WebClient.dll

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

重载

DownloadFileTaskAsync(String, String)	使用任务对象将指定的资源作为异步操作下载到本地文件。
DownloadFileTaskAsync(Uri, String)	使用任务对象将指定的资源作为异步操作下载到本地文件。

DownloadFileTaskAsync(String, String)

Source:

WebClient.cs

使用任务对象将指定的资源作为异步操作下载到本地文件。

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(System::String ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task DownloadFileTaskAsync (string address, string fileName);

member this.DownloadFileTaskAsync : string * string -> System.Threading.Tasks.Task

Public Function DownloadFileTaskAsync (address As String, fileName As String) As Task

参数

address

String

要下载的资源的 URI。

fileName

String

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

返回

Task

表示异步操作的任务对象。

例外

ArgumentNullException

address 参数 null。

-或-

fileName 参数 null。

WebException

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

-或-

下载资源时出错。

InvalidOperationException

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

注解

谨慎

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

此操作不会阻止。 下载数据资源后，返回的 Task 对象将完成。

此方法在 address 参数中指定的 URI 处下载资源。 下载成功完成后，下载的文件将命名为本地计算机上的 fileName。 使用从线程池自动分配的线程资源异步下载该文件。

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

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

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

注意

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

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

DownloadFileTaskAsync(Uri, String)

Source:

WebClient.cs

使用任务对象将指定的资源作为异步操作下载到本地文件。

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(Uri ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task DownloadFileTaskAsync (Uri address, string fileName);

member this.DownloadFileTaskAsync : Uri * string -> System.Threading.Tasks.Task

Public Function DownloadFileTaskAsync (address As Uri, fileName As String) As Task

参数

address

Uri

要下载的资源的 URI。

fileName

String

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

返回

Task

表示异步操作的任务对象。

例外

ArgumentNullException

address 参数 null。

-或-

fileName 参数 null。

WebException

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

-或-

下载资源时出错。

InvalidOperationException

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

注解

谨慎

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

此操作不会阻止。 下载数据资源后，返回的 Task 对象将完成。

此方法在 address 参数中指定的 URI 处下载资源。 下载成功完成后，下载的文件将命名为本地计算机上的 fileName。 使用从线程池自动分配的线程资源异步下载该文件。

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

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

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

注意

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

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