HttpContent.ReadAsStreamAsync メソッド

定義

名前空間:

System.Net.Http

アセンブリ:

netstandard.dll, System.Net.Http.dll

HTTP コンテンツをシリアル化し、コンテンツを表すストリームを返します。

オーバーロード

ReadAsStreamAsync()	HTTP コンテンツをシリアル化し、コンテンツを非同期操作として表すストリームを返します。
ReadAsStreamAsync(CancellationToken)	HTTP コンテンツをシリアル化し、コンテンツを非同期操作として表すストリームを返します。

注釈

このメソッドは、他の方法で実装 CreateContentReadStreamAsync() 場合を除き、コンテンツを内部的にバッファー処理します。

ReadAsStreamAsync()

ソース:

HttpContent.cs

HTTP コンテンツをシリアル化し、コンテンツを非同期操作として表すストリームを返します。

C#

public System.Threading.Tasks.Task<System.IO.Stream> ReadAsStreamAsync();

戻り値

Task<Stream>

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

注釈

この操作はブロックされません。 返された Task<TResult> オブジェクトは、コンテンツを表すストリームがすべて読み取られた後に完了します。

操作が完了すると、返されたタスク オブジェクトの Result プロパティには、HTTP コンテンツを表すストリームが含まれます。 返されたストリームを使用して、さまざまなストリーム API を使用してコンテンツを読み取ることができます。

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、ReadAsStream()によってスローされる例外を参照してください。

ReadAsStreamAsync(CancellationToken)

ソース:

HttpContent.cs

HTTP コンテンツをシリアル化し、コンテンツを非同期操作として表すストリームを返します。

C#

public System.Threading.Tasks.Task<System.IO.Stream> ReadAsStreamAsync(System.Threading.CancellationToken cancellationToken);

パラメーター

cancellationToken

CancellationToken

操作を取り消すキャンセル トークン。

戻り値

Task<Stream>

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

例外

OperationCanceledException

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

注釈

この操作はブロックされません。 返された Task<TResult> オブジェクトは、コンテンツを表すストリームがすべて読み取られた後に完了します (それ以外の場合 CreateContentReadStream(CancellationToken) 実装されていない場合)。 たとえば、HttpClientを使用する場合、SendAsync などのメソッドは、completionOption パラメーターに渡された内容に基づいて条件付きでバッファーする HttpContent から派生したクラスを返します。

操作が完了すると、返されたタスク オブジェクトの Result プロパティには、HTTP コンテンツを表すストリームが含まれます。 返されたストリームを使用して、さまざまなストリーム API を使用してコンテンツを読み取ることができます。

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、ReadAsStream()によってスローされる例外を参照してください。