HttpClient.GetStringAsync 方法

定義

命名空間:

System.Net.Http

組件:

System.Net.Http.dll

組件:

netstandard.dll

將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

多載

GetStringAsync(String)	將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。
GetStringAsync(Uri)	將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。
GetStringAsync(String, CancellationToken)	將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。
GetStringAsync(Uri, CancellationToken)	將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

備註

這項作業不會封鎖。

GetStringAsync(String)

將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(System::String ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync (string requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync (string? requestUri);

member this.GetStringAsync : string -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As String) As Task(Of String)

參數

requestUri

String

傳送要求的目標 URI。

傳回

Task<String>

工作物件，表示非同步作業。

例外狀況

InvalidOperationException

requestUri 必須是絕對 URI，否則必須設定 BaseAddress。

HttpRequestException

要求因為根本問題而失敗，例如網路連線、DNS 失敗、伺服器憑證驗證或逾時 (僅限 .NET Framework)。

TaskCanceledException

僅限 .NET Core 和 .NET 5 和更新版本：要求因逾時而失敗。

備註

這項作業不會封鎖。 傳回的 Task<TResult> 物件會在讀取完整的回應主體之後完成。

注意

如果逾時：

• .NET Framework會擲回 HttpRequestException 。
• .NET Core 會擲回 ， TaskCanceledException 但沒有任何內部例外狀況。
• .NET 5 和更新版本擲回 TaskCanceledException 巢狀 的 TimeoutException 。

GetStringAsync(Uri)

將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Uri ^ requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync (Uri requestUri);

public System.Threading.Tasks.Task<string> GetStringAsync (Uri? requestUri);

member this.GetStringAsync : Uri -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As Uri) As Task(Of String)

參數

requestUri

Uri

傳送要求的目標 URI。

傳回

Task<String>

工作物件，表示非同步作業。

例外狀況

InvalidOperationException

requestUri 必須是絕對 URI，否則必須設定 BaseAddress。

HttpRequestException

要求因為根本問題而失敗，例如網路連線、DNS 失敗、伺服器憑證驗證或逾時 (僅限 .NET Framework)。

TaskCanceledException

僅限 .NET Core 和 .NET 5 和更新版本：要求因逾時而失敗。

備註

這項作業不會封鎖。 傳回的 Task<TResult> 物件會在讀取完整的回應主體之後完成。

注意

如果逾時：

• .NET Framework會擲回 HttpRequestException 。
• .NET Core 會擲回 ， TaskCanceledException 但沒有任何內部例外狀況。
• .NET 5 和更新版本擲回 TaskCanceledException 巢狀 的 TimeoutException 。

GetStringAsync(String, CancellationToken)

將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(System::String ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<string> GetStringAsync (string? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetStringAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As String, cancellationToken As CancellationToken) As Task(Of String)

參數

requestUri

String

傳送要求的目標 URI。

cancellationToken

CancellationToken

用於取消作業的取消權杖。

傳回

Task<String>

工作物件，表示非同步作業。

例外狀況

ArgumentNullException

requestUri 為 null。

HttpRequestException

要求因為根本問題而失敗，例如網路連線、DNS 失敗、伺服器憑證驗證或逾時 (僅限 .NET Framework)。

TaskCanceledException

僅限 .NET Core 和 .NET 5 和更新版本：要求因逾時而失敗。

備註

這項作業不會封鎖。 傳回的 Task<TResult> 物件會在讀取完整的回應主體之後完成。

注意

如果逾時：

• .NET Framework會擲回 HttpRequestException 。
• .NET Core 會擲回 ， TaskCanceledException 但沒有任何內部例外狀況。
• .NET 5 和更新版本擲回 TaskCanceledException 巢狀 的 TimeoutException 。

GetStringAsync(Uri, CancellationToken)

將 GET 要求傳送至指定的 URI，並透過非同步作業，以字串形式傳回回應內容。

public:
 System::Threading::Tasks::Task<System::String ^> ^ GetStringAsync(Uri ^ requestUri, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<string> GetStringAsync (Uri? requestUri, System.Threading.CancellationToken cancellationToken);

member this.GetStringAsync : Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function GetStringAsync (requestUri As Uri, cancellationToken As CancellationToken) As Task(Of String)

參數

requestUri

Uri

傳送要求的目標 URI。

cancellationToken

CancellationToken

用於取消作業的取消權杖。

傳回

Task<String>

工作物件，表示非同步作業。

例外狀況

ArgumentNullException

requestUri 為 null。

HttpRequestException

要求因為根本問題而失敗，例如網路連線、DNS 失敗、伺服器憑證驗證或逾時 (僅限 .NET Framework)。

TaskCanceledException

僅限 .NET Core 和 .NET 5 和更新版本：要求因逾時而失敗。

備註

這項作業不會封鎖。 傳回的 Task<TResult> 物件會在讀取完整的回應主體之後完成。

注意

如果逾時：

• .NET Framework會擲回 HttpRequestException 。
• .NET Core 會擲回 ， TaskCanceledException 但沒有任何內部例外狀況。
• .NET 5 和更新版本擲回 TaskCanceledException 巢狀 的 TimeoutException 。