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 が無効です。

- または -

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

注釈

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

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

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

プロパティが BaseAddress 空の文字列 ("") address ではなく、絶対 URI を含まない場合は、 address と組み合わせて BaseAddress 、要求されたデータの絶対 URI を形成する相対 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 が無効です。

- または -

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

注釈

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

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

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

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

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

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