WebClient クラス

.NET Framework クラス ライブラリ リファレンス

WebClient クラス

URI で識別されるリソースとのデータの送受信用の共通のメソッドを提供します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public Class WebClient
    Inherits Component

Visual Basic (使用法)

Dim instance As WebClient

C#

[ComVisibleAttribute(true)] 
public class WebClient : Component

C++

[ComVisibleAttribute(true)] 
public ref class WebClient : public
 Component

J#

/** @attribute ComVisibleAttribute(true) */ 
public class WebClient extends Component

JScript

ComVisibleAttribute(true) 
public class WebClient extends
 Component

解説

WebClient クラスは、URI で識別されるローカル、イントラネット、またはインターネットの各リソースとのデータの送受信用の共通のメソッドを提供します。

WebClient クラスは、WebRequest クラスを使用してリソースにアクセスできるようにします。WebClient インスタンスは、WebRequest.RegisterPrefix メソッドで登録した WebRequest の子孫を使用してデータにアクセスできます。

メモ
既定では、.NET Framework は、http:、https:、ftp:、および file: の各スキーム識別子で始まる URI をサポートします。

リソースにデータをアップロードするための WebClient のメソッドを次の表に示します。

メソッド	説明
OpenWrite	リソースにデータを送信するために使用する Stream を取得します。
OpenWriteAsync	呼び出し元のスレッドをブロックせずに、リソースにデータを送信するために使用する Stream を取得します。
UploadData	リソースにバイト配列を送信し、任意の応答を含む 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 (内部サーバー エラー) を返す場合があります。

WebClient インスタンスの AllowAutoRedirect は true に設定されています。

継承時の注意 派生クラスは、WebClient の基本クラスの実装を呼び出して、派生クラスが予想どおりに動作できるようにする必要があります。

使用例

リソースの URI を使用してそのリソースを取得し、応答を表示するコード例を次に示します。

Visual Basic

Imports System
Imports System.Net
Imports System.IO



Public Class Test
    
    Public Shared Sub Main(args()
 As String)
        If args Is Nothing
 OrElse args.Length = 0 Then
            Throw New ApplicationException("Specify
 the URI of the resource to retrieve.")
        End If
        Dim client As New
 WebClient()
        
        ' Add a user agent header in case the 
        ' requested URI contains a query.
        client.Headers.Add("user-agent", "Mozilla/4.0
 (compatible; MSIE 6.0; Windows NT 5.2; .NET CLR 1.0.3705;)")
        
        Dim data As Stream = client.OpenRead(args(0))
        Dim reader As New
 StreamReader(data)
        Dim s As String
 = reader.ReadToEnd()
        Console.WriteLine(s)
        data.Close()
        reader.Close()
    End Sub 'Main
End Class 'Test

C#

using System;
using System.Net;
using System.IO;

public class Test
{
    public static void Main
 (string[] args)
    {
        if (args == null || args.Length ==
 0)
        {
            throw new ApplicationException ("Specify the
 URI of the resource to retrieve.");
        }
        WebClient client = new WebClient ();

        // Add a user agent header in case the 
        // requested URI contains a query.

        client.Headers.Add ("user-agent", "Mozilla/4.0 (compatible;
 MSIE 6.0; Windows NT 5.2; .NET CLR 1.0.3705;)");

        Stream data = client.OpenRead (args[0]);
        StreamReader reader = new StreamReader (data);
        string s = reader.ReadToEnd ();
        Console.WriteLine (s);
        data.Close ();
        reader.Close ();
    }
}

C++

#using <System.dll>

using namespace System;
using namespace System::Net;
using namespace System::IO;
int main()
{
   array<String^>^args = Environment::GetCommandLineArgs();
   if ( args == nullptr || args->Length == 1 )
   {
      throw gcnew ApplicationException( "Specify the URI of the resource to
 retrieve." );
   }

   WebClient^ client = gcnew WebClient;
   
   // Add a user agent header in case the 
   // requested URI contains a query.
   client->Headers->Add( "user-agent", "Mozilla/4.0 (compatible;
 MSIE 6.0; Windows NT 5.2; .NET CLR 1.0.3705;)" );
   Stream^ data = client->OpenRead( args[ 1 ] );
   StreamReader^ reader = gcnew StreamReader( data );
   String^ s = reader->ReadToEnd();
   Console::WriteLine( s );
   data->Close();
   reader->Close();
}

.NET Framework のセキュリティ

• WebPermission  (要求された URI またはその要求のリダイレクト先の URI にアクセスするために必要なアクセス許可)。Connect (関連する列挙体)

継承階層

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
      System.Net.WebClient

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WebClient メンバ
System.Net 名前空間
WebRequest
WebResponse
HttpWebRequest クラス
HttpWebResponse クラス