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 所指定的本機檔案正由另一個線程使用。

備註

謹慎

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)

來源:

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