WebClient.OpenReadAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

指定したリソースを含む読み取り可能なストリームを開きます。 これらのメソッドは、呼び出し元のスレッドをブロックしません。

オーバーロード

OpenReadAsync(Uri)	指定したリソースを含む読み取り可能なストリームを開きます。 このメソッドは、呼び出し元のスレッドをブロックしません。
OpenReadAsync(Uri, Object)	指定したリソースを含む読み取り可能なストリームを開きます。 このメソッドは、呼び出し元のスレッドをブロックしません。

OpenReadAsync(Uri)

ソース:

WebClient.cs

指定したリソースを含む読み取り可能なストリームを開きます。 このメソッドは、呼び出し元のスレッドをブロックしません。

public:
 void OpenReadAsync(Uri ^ address);

public void OpenReadAsync (Uri address);

member this.OpenReadAsync : Uri -> unit

Public Sub OpenReadAsync (address As Uri)

パラメーター

address

Uri

取得するリソースの URI。

例外

ArgumentNullException

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

WebException

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

-又は-

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

-又は-

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

注釈

注意

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

このメソッドは、address パラメーターで指定されたリソースへのアクセスに使用される Stream インスタンスを取得します。 ストリームは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して取得されます。 ストリームが使用可能になったときに通知を受信するには、イベント ハンドラーを OpenReadCompleted イベントに追加します。

手記

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

このメソッドは、ストリームが開いている間、呼び出し元のスレッドをブロックしません。 ストリームの待機中にブロックするには、OpenReadAsync メソッドを使用します。

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

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

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

手記

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

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

OpenReadAsync(Uri, Object)

ソース:

WebClient.cs

指定したリソースを含む読み取り可能なストリームを開きます。 このメソッドは、呼び出し元のスレッドをブロックしません。

public:
 void OpenReadAsync(Uri ^ address, System::Object ^ userToken);

public void OpenReadAsync (Uri address, object? userToken);

member this.OpenReadAsync : Uri * obj -> unit

Public Sub OpenReadAsync (address As Uri, userToken As Object)

パラメーター

address

Uri

取得するリソースの URI。

userToken

Object

非同期操作の完了時に呼び出されるメソッドに渡されるユーザー定義オブジェクト。

例外

ArgumentNullException

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

WebException

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

-又は-

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

-又は-

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

注釈

注意

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

このメソッドは、address パラメーターで指定されたリソースへのアクセスに使用される Stream インスタンスを取得します。 ストリームは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して取得されます。 ストリームが使用可能になったときに通知を受信するには、イベント ハンドラーを OpenReadCompleted イベントに追加します。

手記

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

このメソッドは、ストリームが開いている間、呼び出し元のスレッドをブロックしません。 ストリームの待機中にブロックするには、OpenRead メソッドを使用します。

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

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

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

手記

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