WebClient.DownloadStringAsync 方法

定義

命名空間:

System.Net

組件:

System.Net.WebClient.dll

下載指定的資源做為 String 或 Uri。 這些方法不會封鎖呼叫執行緒。

多載

DownloadStringAsync(Uri)	下載指定的資源做為 Uri。 這個方法不會封鎖呼叫執行緒。
DownloadStringAsync(Uri, Object)	將指定的字串下載到指定的資源。 這個方法不會封鎖呼叫執行緒。

DownloadStringAsync(Uri)

來源:

WebClient.cs

下載指定的資源做為 Uri。 這個方法不會封鎖呼叫執行緒。

public:
 void DownloadStringAsync(Uri ^ address);

public void DownloadStringAsync (Uri address);

member this.DownloadStringAsync : Uri -> unit

Public Sub DownloadStringAsync (address As Uri)

參數

address

Uri

Uri，包含要下載的 URI。

例外狀況

ArgumentNullException

address 參數為 null。

WebException

合併 BaseAddress 和 address 而形成的 URI 是無效的。

-或-

下載資源時發生錯誤。

備註

系統會使用從執行緒集區自動設定的執行緒資源，以非同步方式下載資源。

下載資源之後，這個方法會使用 屬性中指定的 Encoding 編碼方式，將資源 String 轉換成 。 此方法不會在下載資源時封鎖呼叫執行緒。 若要在等候伺服器的回應時下載資源並封鎖，請使用 DownloadString 方法。 下載完成時，會 DownloadStringCompleted 引發 事件。 您的應用程式必須處理此事件，才能接收通知。 下載的字串可在 屬性中使用 Result 。

在 .NET Framework 和 .NET Core 1.0 中，您可以呼叫 方法來取消尚未完成的 CancelAsync 非同步作業。

BaseAddress如果屬性不是空字串 (「」) 且 address 不包含絕對 URI， address 則必須是結合 BaseAddress 的相對 URI，才能形成所要求資料的絕對 URI。 QueryString如果屬性不是空字串，則會附加至 address 。

此方法會使用 RETR 命令來下載 FTP 資源。 針對 HTTP 資源，會使用 GET 方法。

注意

在應用程式中啟用網路追蹤時，這個成員會輸出追蹤資訊。 如需詳細資訊，請參閱.NET Framework 中的網路追蹤。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 DownloadString(Uri) 例外狀況。

DownloadStringAsync(Uri, Object)

來源:

WebClient.cs

將指定的字串下載到指定的資源。 這個方法不會封鎖呼叫執行緒。

public:
 void DownloadStringAsync(Uri ^ address, System::Object ^ userToken);

public void DownloadStringAsync (Uri address, object? userToken);

member this.DownloadStringAsync : Uri * obj -> unit

Public Sub DownloadStringAsync (address As Uri, userToken As Object)

參數

address

Uri

Uri，包含要下載的 URI。

userToken

Object

使用者定義的物件，這個物件會在非同步作業完成時傳遞至叫用的方法。

例外狀況

ArgumentNullException

address 參數為 null。

WebException

合併 BaseAddress 和 address 而形成的 URI 是無效的。

-或-

下載資源時發生錯誤。

備註

系統會使用從執行緒集區自動設定的執行緒資源，以非同步方式下載資源。

下載資源之後，這個方法會使用 屬性中指定的 Encoding 編碼方式，將資源 String 轉換成 。 此方法不會在下載資源時封鎖呼叫執行緒。 若要在等候伺服器的回應時下載資源並封鎖，請使用 DownloadString 方法。 下載完成時，會 DownloadStringCompleted 引發 事件。 您的應用程式必須處理此事件，才能接收通知。 下載的字串可在 屬性中使用 Result 。

在 .NET Framework 和 .NET Core 1.0 中，您可以呼叫 方法來取消尚未完成的 CancelAsync 非同步作業。

BaseAddress如果屬性不是空字串 (「」) 且 address 不包含絕對 URI， address 則必須是結合 BaseAddress 的相對 URI，才能形成所要求資料的絕對 URI。 QueryString如果屬性不是空字串，則會附加至 address 。

此方法會使用 RETR 命令來下載 FTP 資源。 針對 HTTP 資源，會使用 GET 方法。

注意

在應用程式中啟用網路追蹤時，這個成員會輸出追蹤資訊。 如需詳細資訊，請參閱.NET Framework 中的網路追蹤。