新規作成日 2017-10-24
最終更新日
WebClient クラス
URIで識別されるリソースとの間で、データを送信し、そして、データを受けるための一般的な方法を提供します。
コンストラクター
| WebClient() | WebClientクラスの新しいインスタンスを初期化します。 |
プロパティ
| AllowReadStreamBuffering | 互換性のために残されています。WebClientインスタンスのために、Internetリソースから、読み込んだデータをバッファするかどうかを示す値を取得する、あるいは、設定します。 |
| AllowWriteStreamBuffering | 互換性のために残されています。WebClientインスタンスのために、Internetリソースから書き込んだデータをバッファするかどうか示す値を取得する、あるいは、設定します。 |
| BaseAddress | WebClientで作成される要求のための基準となるURIを取得する、あるいは、設定します。 |
| CachePolicy | WebRequestオブジェクトを使用して、このWebClientインスタンスで、得られたリソースのためのアプリケーションのキャッシュ・ポリシーを取得する、あるいは、設定します。 |
| CanRaiseEvents | コンポーネントが、イベントを発生させることができるかどうか示す値を取得します。(Component から継承されます。) |
| Container | Componentが含まれるIContainerを取得します。(Component から継承されます。) |
| Credentials | ホストに送信し、そして、要求を認証するために使用されるネットワーク証明書を取得する、あるいは、設定します。 |
| DesignMode | Componentが、現在、デザイン・モードにあるかどうか示す値を取得します。(Component から継承されます。) |
| Encoding | 文字列をアップロード、そして、ダウンロードするのに使用したEncodingを取得、そして、設定します。 |
| Events | このComponentに添付されるイベント・ハンドラのリストを取得します。(Component から継承されます。) |
| Headers | 要求に関連付けられたヘッダの名前と値のペアのコレクションを取得、あるいは、設定します。 |
| Headers | 要求に関連付けられたヘッダの名前と値のペアのコレクションを取得、あるいは、設定します。 |
| IsBusy | Web要求が進行中かどうかを取得します。 |
| Proxy | このWebClientオブジェクトで使用するプロキシを取得する、あるいは、設定します。 |
| QueryString | 要求に関連付けられた問い合わせの名前と値の対のコレクションを取得、あるいは、設定します。 |
| ResponseHeaders | 応答に関連付けられるヘッダの名前と値の対のコレクションを取得します。 |
| Site | ComponentのISiteを取得するか、設定します。(Component から継承されます。) |
| UseDefaultCredentials | DefaultCredentialsが要求と一緒に送信するかどうかを制御するBoolean値を取得する、あるいは、設定します。 |
メソッド
| CancelAsync() | 保留中の非同期動作を取り消します。 |
| CreateObjRef(Type) | リモート・オブジェクトで情報をやりとりするために使用するプロキシを作成するために必要な、すべての関連情報が含まれるオブジェクトを作成します。(MarshalByRefObject から継承されます。) |
| Dispose() | Componentが使用するすべてのリソースを解放します。(Component から継承されます。) |
| Dispose(Boolean) | Componentによって、使用された管理されていないリソースを解放します。そして、必要に応じて、管理されたリソースを解放します。(Component から継承されます。) |
| DownloadData(String) | 指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadData(Uri) | 指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadDataAsync(Uri) | 非同期動作として、指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadDataAsync(Uri, Object) | 非同期動作として、指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadDataTaskAsync(String) | タスク・オブジェクトを使用して、非同期動作として、指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadDataTaskAsync(Uri) | タスク・オブジェクトを使用して、非同期動作として、指定されるURIから、Byte配列としてリソースをダウンロードします。 |
| DownloadFile(String, String) | 指定されたURIを持つリソースをローカルファイルにダウンロードします。 |
| DownloadFile(Uri, String) | 指定されたURIを持つリソースをローカルファイルにダウンロードします。 |
| DownloadFileAsync(Uri, String) | 指定されたURIを持つリソースを、ローカルファイルにダウンロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| DownloadFileAsync(Uri, String, Object) | 指定されたURIを持つリソースを、ローカルファイルにダウンロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| DownloadFileTaskAsync(String, String) | タスク・オブジェクトを使用する非同期動作として、指定されたリソースをローカルファイルにダウンロードします。 |
| DownloadFileTaskAsync(Uri, String) | タスク・オブジェクトを使用する非同期動作として、指定されたリソースをローカルファイルにダウンロードします。 |
| DownloadString(String) | Stringとして要求されたリソースをダウンロードします。ダウンロードするリソースは、URIが含まれているStringとして指定されます。 |
| DownloadString(Uri) | Stringとして要求されたリソースをダウンロードします。ダウンロードするリソースは、Uriとして指定されます。 |
| DownloadStringAsync(Uri) | Uriとして指定されたリソースをダウンロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| DownloadStringAsync(Uri, Object) | 指定されたリソースに、指定された文字列をダウンロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| DownloadStringTaskAsync(String) | タスク・オブジェクトを使用して、非同期動作として、指定されるURIから、Stringとしてリソースをダウンロードします。 |
| Finalize() | Componentは、ガーベージ・コレクションによって取り戻される前に、管理されていないリソースを解放し、そして、他のクリーンアップ操作を実行します。(Component から継承されます。) |
| GetHashCode() | 既定のハッシュ関数として機能します。(Object から継承されます。) |
| GetLifetimeService() | 現在の存続期間サービス・オブジェクトを取得します。それは、このインスタンスのための存続期間ポリシーを制御します。(MarshalByRefObject から継承されます。) |
| GetService(Type) | Component、または、そのContainerによって、提供されるサービスを表現するオブジェクトを返します。(Component から継承されます。) |
| GetType() | 現在のインスタンスのTypeを取得します。(Object から継承されます。) |
| GetWebRequest(Uri) | 指定されたリソースのためのWebRequestオブジェクトを返します。 |
| GetWebResponse(WebRequest) | 指定されたWebRequestのためのWebResponseを返します。 |
| GetWebResponse(WebRequest, IAsyncResult) | 指定されたIAsyncResultを使用して、指定されたWebRequestのためのWebResponseを返します。 |
| InitializeLifetimeService() | このインスタンスのための存続期間ポリシーを制御するために、存続期間サービス・オブジェクトを取得します。(MarshalByRefObject から継承されます。) |
| MemberwiseClone() | 現在のObjectの簡易コピーを作成します。(Object から継承されます。) |
| MemberwiseClone(Boolean) | 現在のMarshalByRefObjectオブジェクトの簡易コピーを作成します。(MarshalByRefObject から継承されます。) |
| OnDownloadDataCompleted(DownloadDataCompletedEventArgs) | DownloadDataCompletedイベントを発生させます。 |
| OnDownloadFileCompleted(AsyncCompletedEventArgs) | DownloadFileCompletedイベントを発生させます。 |
| OnDownloadProgressChanged(DownloadProgressChangedEventArgs) | DownloadProgressChangedイベントを発生させます。 |
| OnDownloadStringCompleted(DownloadStringCompletedEventArgs) | DownloadStringCompletedイベントを発生させます。 |
| OnOpenReadCompleted(OpenReadCompletedEventArgs) | OpenReadCompletedイベントを発生させます。 |
| OnOpenWriteCompleted(OpenWriteCompletedEventArgs) | OpenWriteCompletedイベントを発生させます。 |
| OnUploadDataCompleted(UploadDataCompletedEventArgs) | UploadDataCompletedイベントを発生させます。 |
| OnUploadFileCompleted(UploadFileCompletedEventArgs) | UploadFileCompletedイベントを発生させます。 |
| OnUploadProgressChanged(UploadProgressChangedEventArgs) | UploadProgressChangedイベントを発生させます。 |
| OnUploadStringCompleted(UploadStringCompletedEventArgs) | UploadStringCompletedイベントを発生させます。 |
| OnUploadValuesCompleted(UploadValuesCompletedEventArgs) | UploadValuesCompletedイベントを発生させます。 |
| OnWriteStreamClosed(WriteStreamClosedEventArgs) 互換性のために残されています。 | WriteStreamClosedイベントを発生させます。 |
| OpenRead(String) | Stringとして指定されたURIを持つリソースから、ダウンロードされたデータのために、読み込み可能なストリームを開きます。 |
| OpenRead(Uri) | Uriとして指定されたURIを持つリソースから、ダウンロードされたデータのために、読み込み可能なストリームを開きます。 |
| OpenReadAsync(Uri) | 指定されたリソースが含まれている読み込み可能なストリームを開きます。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| OpenReadAsync(Uri, Object) | 指定されたリソースが含まれている読み込み可能なストリームを開きます。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| OpenReadTaskAsync(String) | 指定されたタスク・オブジェクトを使用して、リソースが含まれている読み込み可能なストリームを、非同期動作として開きます。 |
| OpenReadTaskAsync(Uri) | 指定されたタスク・オブジェクトを使用して、リソースが含まれている読み込み可能なストリームを、非同期動作として開きます。 |
| OpenWrite(String) | 指定されたリソースに、データを書込むためのストリームを開きます。 |
| OpenWrite(String, String) | 指定されたメソッドを使用して、指定されたリソースに、データを書込むためのストリームを開きます。 |
| OpenWrite(Uri) | 指定されたリソースに、データを書込むためのストリームを開きます。 |
| OpenWrite(Uri, String) | 指定されたメソッドを使用することで、指定されたリソースに、データを書込むためのストリームを開きます。 |
| OpenWriteAsync(Uri) | 指定されたリソースに、データを書込むためのストリームを開きます。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| OpenWriteAsync(Uri, String) | 指定されたリソースに、データを書込むためのストリームを開きます。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| OpenWriteAsync(Uri, String, Object) | 指定されたメソッドを使用して、指定されたリソースに、データを書込むためのストリームを開きます。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| OpenWriteTaskAsync(String) | タスク・オブジェクトを使用して、指定されたリソースに非同期動作として、データを書込むためのストリームを開きます。 |
| OpenWriteTaskAsync(String, String) | タスク・オブジェクトを使用して、指定されたリソースに非同期動作として、データを書込むためのストリームを開きます。 |
| OpenWriteTaskAsync(Uri) | タスク・オブジェクトを使用して、指定されたリソースに非同期動作として、データを書込むためのストリームを開きます。 |
| OpenWriteTaskAsync(Uri, String) | タスク・オブジェクトを使用して、指定されたリソースに非同期動作として、データを書込むためのストリームを開きます。 |
| ToString() | 存在する場合、Componentの名前が含まれているStringを返します。このメソッドは、オーバーライドしないでください。(Component から継承されます。) |
| UploadData(String, Byte[]) | データバッファを、URIで確認されるリソースにアップロードします。 |
| UploadData(String, String, Byte[]) | 指定されたメソッドを使用して、データバッファを指定されたリソースにアップロードします。 |
| UploadData(Uri, Byte[]) | データバッファを、URIで確認されるリソースにアップロードします。 |
| UploadData(Uri, String, Byte[]) | 指定されたメソッドを使用して、データバッファを指定されたリソースにアップロードします。 |
| UploadDataAsync(Uri, Byte[]) | POSTメソッドを使用して、データバッファを、URIで識別されるリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadDataAsync(Uri, String, Byte[]) | 指定されたメソッドを使用して、データバッファを、URIで識別されるリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadDataAsync(Uri, String, Byte[], Object) | 指定されたメソッドと識別しているトークンを使用して、データバッファを、URIで識別されるリソースにアップロードします。 |
| UploadDataTaskAsync(String, Byte[]) | タスク・オブジェクトを使用して、指定されるURIに、Byte配列が含まれるデータバッファを非同期動作でアップロードします。 |
| UploadDataTaskAsync(String, String, Byte[]) | タスク・オブジェクトを使用して、指定されるURIに、Byte配列が含まれるデータバッファを非同期動作でアップロードします。 |
| UploadDataTaskAsync(Uri, Byte[]) | タスク・オブジェクトを使用して、指定されるURIに、Byte配列が含まれるデータバッファを非同期動作でアップロードします。 |
| UploadDataTaskAsync(Uri, String, Byte[]) | タスク・オブジェクトを使用して、指定されるURIに、Byte配列が含まれるデータバッファを非同期動作でアップロードします。 |
| UploadFile(String, String) | 指定されたURIで指定されたローカルファイルをリソースにアップロードします。 |
| UploadFile(String, String, String) | 指定されたメソッドを使用して、指定されたローカルファイルを指定されたリソースにアップロードします。 |
| UploadFile(Uri, String) | 指定されたURIで指定されたローカルファイルをリソースにアップロードします。 |
| UploadFile(Uri, String, String) | 指定されたメソッドを使用して、指定されたローカルファイルを指定されたリソースにアップロードします。 |
| UploadFileAsync(Uri, String) | POSTメソッドを使用して、指定されたローカルファイルを指定されたリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadFileAsync(Uri, String, String) | POSTメソッドを使用して、指定されたローカルファイルを指定されたリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadFileAsync(Uri, String, String, Object) | POSTメソッドを使用して、指定されたローカルファイルを指定されたリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadFileTaskAsync(String, String) | タスク・オブジェクトを使用する非同期動作として、指定されたローカルファイルをリソースにアップロードします。 |
| UploadFileTaskAsync(String, String, String) | タスク・オブジェクトを使用する非同期動作として、指定されたローカルファイルをリソースにアップロードします。 |
| UploadFileTaskAsync(Uri, String) | タスク・オブジェクトを使用する非同期動作として、指定された文字列を指定されたリソースにアップロードします。 |
| UploadStringTaskAsync(Uri, String, String) | タスク・オブジェクトを使用する非同期動作として、指定された文字列を指定されたリソースにアップロードします。 |
| UploadValues(String, NameValueCollection) | 指定された名前/値コレクションを、指定されたURIで確認されるリソースにアップロードします。 |
| UploadValues(String, String, NameValueCollection) | 指定されたメソッドを使用して、指定された名前/値コレクションを、指定されたURIで確認されるリソースにアップロードします。 |
| UploadValues(Uri, NameValueCollection) | 指定された名前/値コレクションを、指定されたURIで確認されるリソースにアップロードします。 |
| UploadValues(Uri, String, NameValueCollection) | 指定されたメソッドを使用して、指定された名前/値コレクションを、指定されたURIで確認されるリソースにアップロードします。 |
| UploadValuesAsync(Uri, NameValueCollection) | 指定された名前/値コレクションのデータを、指定されたURIで識別するリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadValuesAsync(Uri, String, NameValueCollection) | 指定されたメソッドを使用して、指定された名前/値コレクションのデータを、指定されたURIで識別するリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 |
| UploadValuesAsync(Uri, String, NameValueCollection, Object) | 指定されたメソッドを使用して、指定された名前/値コレクションのデータを、指定されたURIで識別するリソースにアップロードします。このメソッドは、呼び出し側のスレッドをブロックしません。 そして、呼び出し元が、操作が完了するとき、呼び出されるメソッドにオブジェクトを渡すことができます。 |
| UploadValuesTaskAsync(String, NameValueCollection) | タスク・オブジェクトを使用する非同期動作として、指定された名前/値コレクションを、指定されたURIで特定されるリソースにアップロードします。 |
| UploadValuesTaskAsync(String, String, NameValueCollection) | タスク・オブジェクトを使用する非同期動作として、指定された名前/値コレクションを、指定されたURIで特定されるリソースにアップロードします。 |
| UploadValuesTaskAsync(Uri, NameValueCollection) | タスク・オブジェクトを使用する非同期動作として、指定された名前/値コレクションを、指定されたURIで特定されるリソースにアップロードします。 |
| UploadValuesTaskAsync(Uri, String, NameValueCollection) | タスク・オブジェクトを使用する非同期動作として、指定された名前/値コレクションを、指定されたURIで特定されるリソースにアップロードします。 |
イベント
| Disposed | Disposeメソッドへの呼び出しによって、コンポーネントが、破棄されたときに発生します。(Component から継承されます。) |
| DownloadDataCompleted | 非同期データのダウンロード操作が、完了したときに発生します。 |
| DownloadFileCompleted | 非同期ファイルのダウンロード操作が、完了したときに発生します。 |
| DownloadProgressChanged | 非同期ダウンロード操作が、データの一部、あるいは、全てを正常に転送したとき、発生します。 |
| DownloadStringCompleted | 非同期リソースのダウンロード操作が、完了したときに発生します。 |
| OpenReadCompleted | リソースを含むストリームを開く非同期動作が、完了したときに発生します。 |
| OpenWriteCompleted | リソースにデータを書き込むためのストリームを開く非同期動作が完了したとき、発生します。 |
| UploadDataCompleted | 非同期データのアップロード操作が、完了したときに発生します。 |
| UploadFileCompleted | 非同期ファイルのアップロード操作が、完了したときに発生します。 |
| UploadProgressChanged | 非同期のアップロード操作が、データの一部、あるいは、全てを正常に転送したとき、発生します。 |
| UploadStringCompleted | 非同期の文字列のアップロード操作が、完了したときに発生します。 |
| UploadValuesCompleted | 名前/値コレクションの非同期アップロードが完了したとき、発生します。WriteStreamClosed 互換性のために残されています。非同期動作が、書き込みストリームを閉じることで、リソースにデータを書き込むとき、発生します。 |
備考
WebClientクラスは、ローカル、イントラネットやURIで識別するInternetリソースへの送信データや受信データのために、一般的なメソッドを提供します。
WebClientクラスは、アクセスを提供するために、WebRequestクラスを、WebRequest.RegisterPrefixメソッドを持つWebRequest派生物を登録してデータにアクセスするresources.WebClientインスタンスに使用します。
メモ
既定では、.NET Frameworkは、http:, https:, ftp:,から始まる、URIsとファイルをサポートしています。：スキーム識別子。
次の表では、データをリソースにアップロードするために、WebClientメソッドを説明します。
| メソッド | 解説 |
|---|---|
| OpenWrite | リソースにデータを送信するために使用されるStreamを取得します。 |
| OpenWriteAsync | 呼び出しているスレッドをブロックすることなく、リソースにデータを送信するために使用されるStreamを取得します。 |
| UploadData | byte配列をリソースに送信し、そして、いずれかの応答が含まれるByte配列を返します。 |
| UploadDataAsync | 呼び出しているスレッドをブロックすることなく、Byte配列をリソースに送信します. |
| UploadFile | ローカルファイルをリソースに送信し、そして、いずれかの応答が含まれるByte配列を返します。 |
| UploadFileAsync | 呼び出しているスレッドをブロックすることなく、ローカルファイルをリソースに送信します。 |
| UploadValues | NameValueCollectionをリソースに送信し、そして、いずれかの応答が含まれるByte配列を返します。 |
| UploadValuesAsync | 呼び出しているスレッドをブロックすることなく、NameValueCollectionをリソースに送信し、そして、いずれかの応答が含まれるByte配列を返します。 |
| UploadString | 呼び出しているスレッドをブロックすることなく、Stringをリソースに送信します。 |
| UploadStringAsync | 呼び出しているスレッドをブロックすることなく、Stringをリソースに送信します。 |
次の表は、リソースからデータをダウンロードすることのための、WebClientメソッドを説明します。
| メソッド | 解説 |
|---|---|
| OpenRead | Streamとして、リソースからデータを返します。 |
| OpenReadAsync | 呼び出しているスレッドをブロックすることなく、リソースからデータを返します。 |
| DownloadData | リソースからデータをダウンロードし、Byte配列を返します。 |
| DownloadDataAsync | 呼び出しているスレッドをブロックすることなく、リソースからデータをダウンロードし、Byte配列を返します。 |
| DownloadFile | リソースから、ローカルファイルにデータをダウンロードします。 |
| DownloadFileAsync | 呼び出しているスレッドをブロックすることなく、リソースから、ローカルファイルにデータをダウンロードします。 |
| DownloadString | リソースからStringをダウンロードして、Stringを返します。 |
| DownloadStringAsync | 呼び出しているスレッドをブロックすることなく、リソースから、Stringをダウンロードします。 |
あなたは、完了していない非同期動作を中止するために、CancelAsyncメソッドを使用することができます。
WebClientインスタンスは、既定で選択可能なHTTPヘッダを送信しません。あなたの要求が、選択可能なヘッダを必要とする場合、あなたは、Headersコレクションに、ヘッダを追加する必要があります。例えば、応答してクエリを保持するために、あなたは、ユーザー・エージェント・ヘッダを追加する必要があります。また、サーバは、ユーザー・エージェント・ヘッダが欠落している場合、500（内部サーバーエラー）を返すかもしれません。
AllowAutoRedirectは、WebClientインスタンスをtrueに設定します。継承時の注意: 派生クラスは、派生クラスが期待通りに動作することを保証するために、WebClientの基底クラスの実装を呼び出す必要があります。
使用例
次のコード例は、リソースのURIを取得し、それを取得します。そして、応答を表示します。
要求されたURIに、問合せが含まれる場合に備えて、ユーザー・エージェント・ヘッダを追加します。
セキュリティ
WebPermission
要求されたURIや要求がリダイレクトされるURIにアクセスする
関連する列挙体：F：System.Net.NetworkAccess.Connect。
