HttpClient.TryGetStringAsync(Uri) メソッド

定義

指定 URI に GET 要求を送信し、非同期操作で応答本体を文字列として返します。 HttpClient クラスのプログラミング ガイダンスとコード例については、HttpClient の概念に関するトピックを参照してください。

public:
 virtual IAsyncOperationWithProgress<HttpGetStringResult ^, HttpProgress> ^ TryGetStringAsync(Uri ^ uri) = TryGetStringAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<HttpGetStringResult, HttpProgress> TryGetStringAsync(Uri const& uri);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<HttpGetStringResult,HttpProgress> TryGetStringAsync(System.Uri uri);
function tryGetStringAsync(uri)
Public Function TryGetStringAsync (uri As Uri) As IAsyncOperationWithProgress(Of HttpGetStringResult, HttpProgress)

パラメーター

uri
Uri Uri

要求の送信先 URI。

戻り値

非同期操作を表す オブジェクト。

属性

Windows の要件

デバイス ファミリ
Windows 10, version 1903 (10.0.18362.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v8.0 で導入)

注釈

この操作はブロックされません。 返された IAsyncOperationWithProgress ( HttpGetStringResult および HttpProgress の) は、応答本文全体が読み取られた後に完了します。

HttpClient クラスは、多くの場合、テキストをダウンロードして解析するためにアプリによって使用されます。 HTTP サーバーによって Content-Type ヘッダーで指定された文字エンコードが、HTTP 応答本文の文字エンコード (XML ドキュメント内の XML エンコードなど) と一致しない可能性があります。 テキストで HttpClient を使用する 1 つの方法は、TryGetStringAsync メソッドを呼び出し、返された文字列をテキスト パーサーに渡すことです。 ただし、 Content-Type が文字列として表現可能な型でない場合は、エラーが発生する可能性があります。 XML パーサーで HttpClient を 使用する信頼性の高い方法は、 TryGetBufferAsync メソッドを呼び出し、"<?xml>" 要素のバッファーを解析することです。 次に、指定された文字エンコード ("<xmlversion="1.0" encoding="UTF-8"?>"など) を使用して、HTTP 応答本文を解析します。 他のテキスト形式の場合は、同様のメソッドを使用して、アプリが HTTP 応答本文の最初の部分をスキャンして、使用される文字エンコードを決定できます。

適用対象

こちらもご覧ください