WebClient.DownloadStringAsync メソッド

定義

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

オーバーロード

DownloadStringAsync(Uri)

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

DownloadStringAsync(Uri, Object)

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

DownloadStringAsync(Uri)

ソース:
WebClient.cs
ソース:
WebClient.cs
ソース:
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

例外

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

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

- または -

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

注釈

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

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

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

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

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

Note

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

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

適用対象

DownloadStringAsync(Uri, Object)

ソース:
WebClient.cs
ソース:
WebClient.cs
ソース:
WebClient.cs

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

public:
 void DownloadStringAsync(Uri ^ address, System::Object ^ userToken);
public void DownloadStringAsync (Uri address, 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

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

例外

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

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

- または -

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

注釈

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

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

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

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

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

Note

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

適用対象