WebClient.DownloadFileTaskAsync 方法

定義

命名空間:

System.Net

組件:

System.Net.WebClient.dll

使用工作物件，以非同步作業的方式將指定的資源載入至本機檔案。 這些方法不會封鎖呼叫執行緒。

多載

DownloadFileTaskAsync(String, String)	使用工作物件，以非同步作業的方式將指定的資源載入至本機檔案。
DownloadFileTaskAsync(Uri, String)	使用工作物件，以非同步作業的方式將指定的資源載入至本機檔案。

DownloadFileTaskAsync(String, String)

來源:

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 回的物件會在下載資料資源之後完成。

這個方法會在 參數中指定的 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)

來源:

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 回的物件會在下載資料資源之後完成。

這個方法會在 參數中指定的 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 網頁中使用這個方法時，如果頁面執行的帳戶沒有存取本機檔案的許可權，您會收到錯誤。