WebClient.DownloadStringAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

String または Uriとして指定されたリソースをダウンロードします。 これらのメソッドは、呼び出し元のスレッドをブロックしません。

オーバーロード

DownloadStringAsync(Uri)	Uriとして指定されたリソースをダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。
DownloadStringAsync(Uri, Object)	指定した文字列を指定したリソースにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

DownloadStringAsync(Uri)

ソース:

WebClient.cs

Uriとして指定されたリソースをダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

public:
 void DownloadStringAsync(Uri ^ address);

public void DownloadStringAsync (Uri address);

member this.DownloadStringAsync : Uri -> unit

Public Sub DownloadStringAsync (address As Uri)

パラメーター

address

Uri

ダウンロードする URI を含む Uri。

例外

ArgumentNullException

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

WebException

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

-又は-

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

注釈

注意

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

リソースは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

リソースをダウンロードした後、このメソッドは、Encoding プロパティで指定されたエンコードを使用して、リソースを Stringに変換します。 このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。 サーバーの応答を待機している間にリソースをダウンロードしてブロックするには、DownloadString メソッドを使用します。 ダウンロードが完了すると、DownloadStringCompleted イベントが発生します。 通知を受信するには、アプリケーションでこのイベントを処理する必要があります。 ダウンロードした文字列は、Result プロパティで使用できます。

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

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

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

手記

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

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

DownloadStringAsync(Uri, Object)

ソース:

WebClient.cs

指定した文字列を指定したリソースにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

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

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

member this.DownloadStringAsync : Uri * obj -> unit

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

パラメーター

address

Uri

ダウンロードする URI を含む Uri。

userToken

Object

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

例外

ArgumentNullException

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

WebException

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

-又は-

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

注釈

注意

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

リソースは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

リソースをダウンロードした後、このメソッドは、Encoding プロパティで指定されたエンコードを使用して、リソースを Stringに変換します。 このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。 サーバーの応答を待機している間にリソースをダウンロードしてブロックするには、DownloadString メソッドを使用します。 ダウンロードが完了すると、DownloadStringCompleted イベントが発生します。 通知を受信するには、アプリケーションでこのイベントを処理する必要があります。 ダウンロードした文字列は、Result プロパティで使用できます。

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

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

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

手記

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