HttpClient.GetStringAsync メソッド

定義

名前空間:: System.Net.Http

アセンブリ:: System.Net.Http.dll

アセンブリ:: netstandard.dll, System.Net.Http.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

オーバーロード

名前	説明
GetStringAsync(String)	指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。
GetStringAsync(Uri)	指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。
GetStringAsync(String, CancellationToken)	指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。
GetStringAsync(Uri, CancellationToken)	指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

注釈

この操作はブロックされません。

GetStringAsync(String)

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

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 エラー、サーバー証明書検証エラー、無効なサーバー応答など、有効な HTTP 応答の取得に関する問題が原因で要求が失敗しました。 .NET 8 以降のバージョンでは、理由は HttpRequestError

-又は-

応答状態コードが 200 から 299 の範囲外でした (標準に従って成功したことを示します)。

-又は-

.NET Framework のみ: 要求がタイムアウトしました。

OperationCanceledException

.NET Core と .NET 5 以降のみ: タイムアウトのため要求が失敗しました。

UriFormatException

指定された要求 URI が有効な相対 URI または絶対 URI ではありません。

注釈

この操作はブロックされません。返された Task<TResult> オブジェクトは、応答本文全体が読み取られた後に完了します。内部的には、この操作では HttpResponseMessage.EnsureSuccessStatusCode を使用して、応答状態コードが成功範囲 (200 から 299) にあることを確認し、そうでない場合は HttpRequestException をスローします。一部のシナリオでは、成功と見なされる状態コードをより詳細に制御する必要がある場合があります。たとえば、API は常に 200 OKを返す必要があります。このような場合は、 StatusCode が期待値と一致するかどうかを手動で確認することをお勧めします。

Note

タイムアウトが発生した場合:

.NET Framework は、HttpRequestException をスローします。
.NET Core は、内部例外なしで OperationCanceledException をスローします。
.NET 5 以降のバージョンでは、OperationCanceledExceptionを入れ子にするTimeoutExceptionがスローされます。

適用対象

GetStringAsync(Uri)

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

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

-又は-

応答状態コードが 200 から 299 の範囲外でした (標準に従って成功したことを示します)。

-又は-

.NET Framework のみ: 要求がタイムアウトしました。

OperationCanceledException

.NET Core と .NET 5 以降のみ: タイムアウトのため要求が失敗しました。

注釈

Note

タイムアウトが発生した場合:

.NET Framework は、HttpRequestException をスローします。
.NET Core は、内部例外なしで OperationCanceledException をスローします。
.NET 5 以降のバージョンでは、OperationCanceledExceptionを入れ子にするTimeoutExceptionがスローされます。

適用対象

GetStringAsync(String, CancellationToken)

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

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

-又は-

応答状態コードが 200 から 299 の範囲外でした (標準に従って成功したことを示します)。

UriFormatException

指定された要求 URI が有効な相対 URI または絶対 URI ではありません。

OperationCanceledException

キャンセルトークンが取り消されました。この例外は、返されたタスクに格納されます。

-又は-

.NET Core と .NET 5 以降のみ: タイムアウトのため要求が失敗しました。

注釈

Note

タイムアウトが発生した場合:

.NET Framework は、HttpRequestException をスローします。
.NET Core は、内部例外なしで OperationCanceledException をスローします。
.NET 5 以降のバージョンでは、OperationCanceledExceptionを入れ子にするTimeoutExceptionがスローされます。

適用対象

GetStringAsync(Uri, CancellationToken)

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

ソース:: HttpClient.cs

指定した URI に GET 要求を送信し、非同期操作で応答本文を文字列として返します。

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

-又は-

応答状態コードが 200 から 299 の範囲外でした (標準に従って成功したことを示します)。

OperationCanceledException

キャンセルトークンが取り消されました。この例外は、返されたタスクに格納されます。

-又は-

.NET Core と .NET 5 以降のみ: タイムアウトのため要求が失敗しました。

注釈

Note

タイムアウトが発生した場合:

.NET Framework は、HttpRequestException をスローします。
.NET Core は、内部例外なしで OperationCanceledException をスローします。
.NET 5 以降のバージョンでは、OperationCanceledExceptionを入れ子にするTimeoutExceptionがスローされます。

適用対象

フィードバック

このページはお役に立ちましたか?