WebClient.Headers プロパティ

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

WebClient.Headers プロパティ

要求に関連付けられているヘッダーの名前/値ペアのコレクションを取得または設定します。

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

Visual Basic (宣言)

Public Property Headers As
 WebHeaderCollection

Visual Basic (使用法)

Dim instance As WebClient
Dim value As WebHeaderCollection

value = instance.Headers

instance.Headers = value

C#

public WebHeaderCollection Headers { get; set;
 }

C++

public:
property WebHeaderCollection^ Headers {
    WebHeaderCollection^ get ();
    void set (WebHeaderCollection^ value);
}

J#

/** @property */
public WebHeaderCollection get_Headers ()

/** @property */
public void set_Headers (WebHeaderCollection
 value)

JScript

public function get Headers
 () : WebHeaderCollection

public function set Headers
 (value : WebHeaderCollection)

プロパティ値
要求に関連付けられているヘッダーの名前/値ペアを格納する WebHeaderCollection。

解説

Headers プロパティは、WebClient が要求で送信するヘッダー情報を含む WebHeaderCollection インスタンスを格納します。これは無制限のヘッダーのコレクションであるため、HttpWebRequest などの WebRequest の子孫で制限されるヘッダーを設定できます。

使用例

Headers コレクションを使用して、HTTP Content-Type ヘッダーを application/x-www-form-urlencoded, に設定し、フォーム データがポストに追加されたことをサーバーに通知するコード例を次に示します。

Visual Basic

Dim uriString As String
Console.Write(ControlChars.Cr + "Please enter the URI to post
 data to{for example, http://www.contoso.com} : ")
uriString = Console.ReadLine()
' Create a new WebClient instance.
Dim myWebClient As New WebClient()
Console.WriteLine(ControlChars.Cr + "Please enter the data to
 be posted to the URI {0}:", uriString)
Dim postData As String =
 Console.ReadLine()
myWebClient.Headers.Add("Content-Type", "application/x-www-form-urlencoded")
' Apply ASCII Encoding to obtain the string as a byte array.
Dim byteArray As Byte()
 = Encoding.ASCII.GetBytes(postData)
Console.WriteLine("Uploading to {0} ...", uriString)
' Upload the input string using the HTTP 1.0 POST method.
Dim responseArray As Byte()
 = myWebClient.UploadData(uriString, "POST", byteArray)
' Decode and display the response.
Console.WriteLine(ControlChars.Cr + "Response received was :{0}",
 Encoding.ASCII.GetString(responseArray))

C#

string uriString;
Console.Write("\nPlease enter the URI to post data to {for
 example, http://www.contoso.com} : ");
uriString = Console.ReadLine();
// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
Console.WriteLine("\nPlease enter the data to be posted to the URI {0}:"
,uriString);
string postData = Console.ReadLine();
myWebClient.Headers.Add("Content-Type","application/x-www-form-urlencoded");
// Apply ASCII Encoding to obtain the string as a byte array.
byte[] byteArray = Encoding.ASCII.GetBytes(postData);
Console.WriteLine("Uploading to {0} ...",  uriString);                
        
// Upload the input string using the HTTP 1.0 POST method.
byte[] responseArray = myWebClient.UploadData(uriString,"POST",byteArray);
// Decode and display the response.
Console.WriteLine("\nResponse received was {0}",
    Encoding.ASCII.GetString(responseArray));

C++

String^ uriString;
Console::Write( "\nPlease enter the URI to post data to {for
 example, http://www.contoso.com}: " );
uriString = Console::ReadLine();
// Create a new WebClient instance.
WebClient^ myWebClient = gcnew WebClient;
Console::WriteLine( "\nPlease enter the data to be posted to the URI {0}:",
 uriString );
String^ postData = Console::ReadLine();
myWebClient->Headers->Add( "Content-Type", "application/x-www-form-urlencoded"
 );
// Apply ASCII Encoding to obtain the String^ as a Byte array.
array<Byte>^ byteArray = Encoding::ASCII->GetBytes( postData );
Console::WriteLine( "Uploading to {0} ...", uriString );
// Upload the input String* using the HTTP 1.0 POST method.
array<Byte>^responseArray = myWebClient->UploadData( uriString, "POST",
 byteArray );
// Decode and display the response.
Console::WriteLine( "\nResponse received was {0}",
   Encoding::ASCII->GetString( responseArray ) );

J#

String uriString;
Console.Write("\nPlease enter the URI to post data to {" 
    + "for example, http://www.contoso.com}
 : ");
uriString = Console.ReadLine();
// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
Console.WriteLine("\nPlease enter the data to be posted to the" 
    + " URI {0}:", uriString);
String postData = Console.ReadLine();
myWebClient.get_Headers().Add("Content-Type",
    "application/x-www-form-urlencoded");
// Apply ASCII Encoding to obtain the string as a byte array.
ubyte byteArray[] = Encoding.get_ASCII().GetBytes(postData);
Console.WriteLine("Uploading to {0} ...", uriString);
// Upload the input string using the HTTP 1.0 POST method.
ubyte responseArray[] = myWebClient.UploadData(uriString, "POST",
    byteArray);
// Decode and display the response.
Console.WriteLine("\nResponse received was {0}", Encoding.
    get_ASCII().GetString(responseArray));

プラットフォーム

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 クラス
WebClient メンバ
System.Net 名前空間
WebRequest.Headers
HttpWebRequest.Headers プロパティ