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 指定的本地文件正由另一个线程使用。

注解

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

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

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

BaseAddress如果属性不是空字符串 (“”) ，并且address未指定绝对 URI，address则必须是一个相对 URI，与 BaseAddress 组合以构成所请求数据的绝对 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 指定的本地文件正由另一个线程使用。

注解

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

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

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

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

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

备注

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

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