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 無效。

-或-

下載資源時發生錯誤。

備註

謹慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已經過時，您不應該將它們用於新的開發。 請改用 HttpClient。

資源會使用從線程集區自動配置的線程資源，以異步方式下載資源。

下載資源之後，這個方法會使用 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 無效。

-或-

下載資源時發生錯誤。

備註

謹慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已經過時，您不應該將它們用於新的開發。 請改用 HttpClient。

資源會使用從線程集區自動配置的線程資源，以異步方式下載資源。

下載資源之後，這個方法會使用 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 中的網路追蹤。