WebClient.OpenReadTaskAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

タスク オブジェクトを使用して、指定したリソースを含む読み取り可能なストリームを非同期操作として開きます。 これらのメソッドは、呼び出し元のスレッドをブロックしません。

オーバーロード

OpenReadTaskAsync(String)	タスク オブジェクトを使用して、指定したリソースを含む読み取り可能なストリームを非同期操作として開きます。
OpenReadTaskAsync(Uri)	タスク オブジェクトを使用して、指定したリソースを含む読み取り可能なストリームを非同期操作として開きます。

OpenReadTaskAsync(String)

ソース:

WebClient.cs

タスク オブジェクトを使用して、指定したリソースを含む読み取り可能なストリームを非同期操作として開きます。

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenReadTaskAsync(System::String ^ address);

public System.Threading.Tasks.Task<System.IO.Stream> OpenReadTaskAsync (string address);

member this.OpenReadTaskAsync : string -> System.Threading.Tasks.Task<System.IO.Stream>

Public Function OpenReadTaskAsync (address As String) As Task(Of Stream)

パラメーター

address

String

取得するリソースの URI。

戻り値

Task<Stream>

非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、リソースからデータを読み取るために使用する Stream を返します。

例外

ArgumentNullException

address パラメーターは nullです。

WebException

BaseAddress とアドレスを組み合わせて形成された URI が無効です。

-又は-

リソースのダウンロード中にエラーが発生しました。

-又は-

ストリームを開くときにエラーが発生しました。

注釈

注意

WebRequest、HttpWebRequest、ServicePoint、WebClient は廃止されており、新しい開発には使用しないでください。 代わりに HttpClient を使用してください。

この操作はブロックされません。 返された Task<TResult> オブジェクトは、データ リソースへの読み取り可能なストリームが開かれた後に完了します。 このメソッドは、ストリームが開いている間、呼び出し元のスレッドをブロックしません。

このメソッドは、address パラメーターで指定されたリソースへのアクセスに使用される Stream インスタンスを取得します。 ストリームは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して取得されます。

手記

システム リソースが不足しないように、Stream が完了したら、Stream.Close を呼び出す必要があります。

.NET Framework および .NET Core 1.0 では、CancelAsync メソッドを呼び出すことによって、完了していない非同期操作を取り消すことができます。

BaseAddress プロパティが空の文字列 ("") ではなく、address が絶対 URI を指定しない場合、address は、要求されたリソースの絶対 URI を形成するために BaseAddress と組み合わせた相対 URI である必要があります。 QueryString プロパティが nullされていない場合は、addressに追加されます。

この方法では、RETR コマンドを使用して FTP リソースをダウンロードします。 HTTP リソースの場合、GET メソッドが使用されます。

手記

このメンバーは、アプリケーションでネットワーク トレースを有効にすると、トレース情報を出力します。 詳細については、「.NET Frameworkでのネットワーク トレースの 」を参照してください。

こちらもご覧ください

• Stream

OpenReadTaskAsync(Uri)

ソース:

WebClient.cs

タスク オブジェクトを使用して、指定したリソースを含む読み取り可能なストリームを非同期操作として開きます。

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenReadTaskAsync(Uri ^ address);

public System.Threading.Tasks.Task<System.IO.Stream> OpenReadTaskAsync (Uri address);

member this.OpenReadTaskAsync : Uri -> System.Threading.Tasks.Task<System.IO.Stream>

Public Function OpenReadTaskAsync (address As Uri) As Task(Of Stream)

パラメーター

address

Uri

取得するリソースの URI。

戻り値

Task<Stream>

非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、リソースからデータを読み取るために使用する Stream を返します。

例外

ArgumentNullException

address パラメーターは nullです。

WebException

BaseAddress とアドレスを組み合わせて形成された URI が無効です。

-又は-

リソースのダウンロード中にエラーが発生しました。

-又は-

ストリームを開くときにエラーが発生しました。

注釈

注意

WebRequest、HttpWebRequest、ServicePoint、WebClient は廃止されており、新しい開発には使用しないでください。 代わりに HttpClient を使用してください。

この操作はブロックされません。 返された Task<TResult> オブジェクトは、データ リソースへの読み取り可能なストリームが開かれた後に完了します。 このメソッドは、ストリームが開いている間、呼び出し元のスレッドをブロックしません。

このメソッドは、address パラメーターで指定されたリソースへのアクセスに使用される Stream インスタンスを取得します。 ストリームは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して取得されます。

手記

システム リソースが不足しないように、Stream が完了したら、Stream.Close を呼び出す必要があります。

.NET Framework および .NET Core 1.0 では、CancelAsync メソッドを呼び出すことによって、完了していない非同期操作を取り消すことができます。

BaseAddress プロパティが空の文字列 ("") ではなく、address が絶対 URI を指定しない場合、address は、要求されたリソースの絶対 URI を形成するために BaseAddress と組み合わせた相対 URI である必要があります。 QueryString プロパティが nullされていない場合は、addressに追加されます。

この方法では、RETR コマンドを使用して FTP リソースをダウンロードします。 HTTP リソースの場合、GET メソッドが使用されます。

手記

このメンバーは、アプリケーションでネットワーク トレースを有効にすると、トレース情報を出力します。 詳細については、「.NET Frameworkでのネットワーク トレースの 」を参照してください。

こちらもご覧ください

• Stream