WebClient.DownloadStringTaskAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

タスク オブジェクトを使用して、非同期操作として指定された URI からリソースを String としてダウンロードします。 これらのメソッドは、呼び出し元のスレッドをブロックしません。

オーバーロード

DownloadStringTaskAsync(String)	タスク オブジェクトを使用して、非同期操作として指定された URI からリソースを String としてダウンロードします。
DownloadStringTaskAsync(Uri)	タスク オブジェクトを使用して、非同期操作として指定された URI からリソースを String としてダウンロードします。

DownloadStringTaskAsync(String)

ソース:

WebClient.cs

タスク オブジェクトを使用して、非同期操作として指定された URI からリソースを String としてダウンロードします。

public:
 System::Threading::Tasks::Task<System::String ^> ^ DownloadStringTaskAsync(System::String ^ address);

public System.Threading.Tasks.Task<string> DownloadStringTaskAsync (string address);

member this.DownloadStringTaskAsync : string -> System.Threading.Tasks.Task<string>

Public Function DownloadStringTaskAsync (address As String) As Task(Of String)

パラメーター

address

String

ダウンロードするリソースの URI。

戻り値

Task<String>

非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、ダウンロードしたリソースを含む Byte 配列を返します。

例外

ArgumentNullException

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

WebException

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

-又は-

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

注釈

注意

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

この操作はブロックされません。 返された Task<TResult> オブジェクトは、データ リソースのダウンロード後に完了します。 リソースは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

リソースをダウンロードした後、このメソッドは、Encoding プロパティで指定されたエンコードを使用して、リソースを Stringに変換します。 このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。

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

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

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

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

DownloadStringTaskAsync(Uri)

ソース:

WebClient.cs

タスク オブジェクトを使用して、非同期操作として指定された URI からリソースを String としてダウンロードします。

public:
 System::Threading::Tasks::Task<System::String ^> ^ DownloadStringTaskAsync(Uri ^ address);

public System.Threading.Tasks.Task<string> DownloadStringTaskAsync (Uri address);

member this.DownloadStringTaskAsync : Uri -> System.Threading.Tasks.Task<string>

Public Function DownloadStringTaskAsync (address As Uri) As Task(Of String)

パラメーター

address

Uri

ダウンロードするリソースの URI。

戻り値

Task<String>

非同期操作を表すタスク オブジェクト。 タスク オブジェクトの Result プロパティは、ダウンロードしたリソースを含む Byte 配列を返します。

例外

ArgumentNullException

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

WebException

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

-又は-

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

注釈

注意

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

この操作はブロックされません。 返された Task<TResult> オブジェクトは、データ リソースのダウンロード後に完了します。 リソースは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

リソースをダウンロードした後、このメソッドは、Encoding プロパティで指定されたエンコードを使用して、リソースを Stringに変換します。 このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。

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

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

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

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