WebClient.DownloadString 方法

定義

命名空間:

System.Net

組件:

netstandard.dll, System.Net.WebClient.dll

將要求的資源下載為 String。 下載的資源可以指定為包含 URI 或 Uri的 String。

多載

名稱	Description
DownloadString(String)	將要求的資源下載為 String。 要下載的資源會指定為包含 URI 的 String。
DownloadString(Uri)	將要求的資源下載為 String。 要下載的資源會指定為 Uri。

DownloadString(String)

來源:

WebClient.cs

將要求的資源下載為 String。 要下載的資源會指定為包含 URI 的 String。

public:
 System::String ^ DownloadString(System::String ^ address);

public string DownloadString(string address);

member this.DownloadString : string -> string

Public Function DownloadString (address As String) As String

參數

address

String

包含要下載之 URI 的 String。

傳回

String

包含所要求資源的 String。

例外狀況

ArgumentNullException

address 參數是 null。

WebException

結合 BaseAddress 和 address 所形成的 URI 無效。

-或-

下載資源時發生錯誤。

NotSupportedException

方法已在多個線程上同時呼叫。

範例

下列程式代碼範例示範呼叫這個方法。

void DownloadString( String^ address )
{
   WebClient^ client = gcnew WebClient;
   String^ reply = client->DownloadString( address );
   Console::WriteLine( reply );
}

public static void DownloadString(string address)
{
    WebClient client = new WebClient();
    string reply = client.DownloadString(address);

    Console.WriteLine(reply);
}

Public Shared Sub DownloadString(ByVal address As String)

    Dim client As WebClient = New WebClient()
    Dim reply As String = client.DownloadString(address)

    Console.WriteLine(reply)
End Sub

備註

謹慎

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

這個方法會擷取指定的資源。 下載資源之後，方法會使用 Encoding 屬性中指定的編碼方式，將資源轉換成 String。 此方法會在下載資源時封鎖。 若要下載資源，並在等候伺服器的回應時繼續執行，請使用其中一個 DownloadStringAsync 方法。

如果 BaseAddress 屬性不是空字串 （“”） 且 address 不包含絕對 URI，address 必須是與 BaseAddress 結合的相對 URI，才能形成所要求數據的絕對 URI。 如果 QueryString 屬性不是空字串，則會附加至 address。

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

注意

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

DownloadString(Uri)

來源:

WebClient.cs

將要求的資源下載為 String。 要下載的資源會指定為 Uri。

public:
 System::String ^ DownloadString(Uri ^ address);

public string DownloadString(Uri address);

member this.DownloadString : Uri -> string

Public Function DownloadString (address As Uri) As String

參數

address

Uri

包含要下載之 URI 的 Uri 物件。

傳回

String

包含所要求資源的 String。

例外狀況

ArgumentNullException

address 參數是 null。

WebException

結合 BaseAddress 和 address 所形成的 URI 無效。

-或-

下載資源時發生錯誤。

NotSupportedException

方法已在多個線程上同時呼叫。

備註

謹慎

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

這個方法會擷取指定的資源。 下載資源之後，方法會使用 Encoding 屬性中指定的編碼方式，將資源轉換成 String。 此方法會在下載資源時封鎖。 若要下載資源，並在等候伺服器的回應時繼續執行，請使用其中一個 DownloadStringAsync 方法。

如果 BaseAddress 屬性不是空字串 （“”） 且 address 不包含絕對 URI，address 必須是與 BaseAddress 結合的相對 URI，才能形成所要求數據的絕對 URI。 如果 QueryString 屬性不是空字串，則會附加至 address。

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

注意

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