WebClient.DownloadFileAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,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
要放在本地计算机上的文件的名称。
例外
fileName
指定的本地文件正由另一个线程使用。
注解
此方法在 参数中指定的 URI 处 address
下载资源。 下载成功完成后,下载的文件将在本地计算机上命名 fileName
。 使用从线程池自动分配的线程资源异步下载文件。 若要在文件可用时接收通知,请将事件处理程序添加到 DownloadFileCompleted 事件。
下载资源时,此方法不会阻止调用线程。 若要在等待下载完成时阻止,请使用 方法之 DownloadFile 一。
在 .NET Framework 和 .NET Core 1.0 中,可以通过调用 方法来取消尚未完成的CancelAsync异步操作。
BaseAddress如果属性不是空字符串 (“”) ,并且address
未指定绝对 URI,address
则必须是一个相对 URI,与 BaseAddress 组合以构成所请求数据的绝对 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
将具有指定 URI 的资源下载到本地文件。 此方法不会阻止调用线程。
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)
参数
- address
- Uri
要下载的资源的 URI。
- fileName
- String
要放在本地计算机上的文件的名称。
- userToken
- Object
一个用户定义对象,此对象将传递给完成异步操作后所调用的方法。
例外
fileName
指定的本地文件正由另一个线程使用。
注解
此方法在 参数中指定的 URI 处 address
下载资源。 下载成功完成后,下载的文件将在本地计算机上命名 fileName
。 使用从线程池自动分配的线程资源异步下载文件。 若要在文件可用时接收通知,请将事件处理程序添加到 DownloadFileCompleted 事件。
下载资源时,此方法不会阻止调用线程。 若要在等待下载完成时阻止,请使用 方法之 DownloadFile 一。
在 .NET Framework 和 .NET Core 1.0 中,可以通过调用 方法来取消尚未完成的CancelAsync异步操作。
BaseAddress如果属性不是空字符串 (“”) ,并且address
未指定绝对 URI,address
则必须是一个相对 URI,与 BaseAddress 组合以构成所请求数据的绝对 URI。 QueryString如果 属性不是空字符串,则会将其追加到 address
。
此方法使用 RETR 命令下载 FTP 资源。 对于 HTTP 资源,使用 GET 方法。
备注
当你在应用程序中启用网络跟踪后,此成员将输出跟踪信息。 有关详细信息,请参阅 .NET Framework 中的网络跟踪。
在 ASP.NET 页中使用此方法时,如果执行页面的帐户无权访问本地文件,则会收到错误。
适用于
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈