HttpWebRequest.Headers プロパティ

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

HttpWebRequest.Headers プロパティ

HTTP ヘッダーを構成する名前と値のペアのコレクションを指定します。

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

Visual Basic (宣言)

Public Overrides Property
 Headers As WebHeaderCollection

Visual Basic (使用法)

Dim instance As HttpWebRequest
Dim value As WebHeaderCollection

value = instance.Headers

instance.Headers = value

C#

public override WebHeaderCollection Headers { get;
 set; }

C++

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

J#

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

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

JScript

public override function get
 Headers () : WebHeaderCollection

public override function set
 Headers (value : WebHeaderCollection)

プロパティ値
HTTP 要求のヘッダーを構成する名前と値のペアを格納している WebHeaderCollection。

例外

例外の種類	条件
InvalidOperationException	要求が GetRequestStream、BeginGetRequestStream、GetResponse、または BeginGetResponse の各メソッドの呼び出しによって開始されました。

解説

Headers コレクションは、要求に関連付けられているプロトコル ヘッダーを格納します。Headers コレクションには格納されず、システム、プロパティ、またはメソッドのいずれかで設定される HTTP ヘッダーの一覧を次の表に示します。

ヘッダー	設定方法
Accept	Accept プロパティで設定します。
Connection	Connection プロパティまたは KeepAlive プロパティで設定します。
Content-Length	ContentLength プロパティで設定します。
Content-Type	ContentType プロパティで設定します。
Expect	Expect プロパティで設定します。
日付	システムにより現在の日付に設定されます。
Host	システムにより現在のホスト情報に設定されます。
If-Modified-Since	IfModifiedSince プロパティで設定します。
Range	AddRange メソッドで設定します。
Referer	Referer プロパティで設定します。
Transfer-Encoding	TransferEncoding プロパティで設定します (SendChunked プロパティは true である必要があります)。
User-Agent	UserAgent プロパティで設定します。

これらの保護されたヘッダーの 1 つを設定しようとすると、Add メソッドは ArgumentException をスローします。

GetRequestStream、BeginGetRequestStream、GetResponse、または BeginGetResponse の各メソッドの呼び出しによって開始した要求の後に Headers プロパティを変更すると、InvalidOperationException がスローされます。

Web サーバーおよびキャッシュにより、Web 要求のヘッダーが変更されたり追加されたりすることがあるため、ヘッダーの値は変わることがあります。

使用例

HTTP ヘッダーの名前と値のペアを、Headers プロパティを使用してコンソールに出力するコード例を次に示します。

Visual Basic

     ' Create a new 'HttpWebRequest' Object to the mentioned URL.
     Dim myHttpWebRequest As HttpWebRequest
 = CType(WebRequest.Create("http://www.contoso.com"),
 HttpWebRequest)
     ' Assign the response object of 'HttpWebRequest' to a 'HttpWebResponse'
 variable.
     Dim myHttpWebResponse As HttpWebResponse
 = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
     Console.WriteLine(ControlChars.Cr + "The HttpHeaders are
 " + ControlChars.Cr + ControlChars.Cr + ControlChars.Tab + "Name"
 + ControlChars.Tab + ControlChars.Tab + "Value" + ControlChars.Cr + "{0}", myHttpWebRequest.Headers)

     ' Print the HTML contents of the page to the console. 
     Dim streamResponse As Stream = myHttpWebResponse.GetResponseStream()
     Dim streamRead As New
 StreamReader(streamResponse)
     Dim readBuff(256) As [Char]
     Dim count As Integer
 = streamRead.Read(readBuff, 0, 256)
     Console.WriteLine(ControlChars.Cr + "The HTML contents of
 page the are  : " + ControlChars.Cr + ControlChars.Cr + "
 ")
     While count > 0
         Dim outputData As New
 [String](readBuff, 0, count)
         Console.Write(outputData)
         count = streamRead.Read(readBuff, 0, 256)
     End While
' Close the Stream object.
streamResponse.Close()
streamRead.Close()
' Release the HttpWebResponse Resource.
 myHttpWebResponse.Close()

C#

// Create a new 'HttpWebRequest' Object to the mentioned URL.
HttpWebRequest myHttpWebRequest=(HttpWebRequest)WebRequest.Create("http://www.contoso.com");
// Assign the response object of 'HttpWebRequest' to a 'HttpWebResponse'
 variable.
HttpWebResponse myHttpWebResponse=(HttpWebResponse)myHttpWebRequest.GetResponse();
Console.WriteLine("\nThe HttpHeaders are \n\n\tName\t\tValue\n{0}",myHttpWebRequest.Headers);
// Print the HTML contents of the page to the console. 
Stream streamResponse=myHttpWebResponse.GetResponseStream();
StreamReader streamRead = new StreamReader( streamResponse );
Char[] readBuff = new Char[256];
int count = streamRead.Read( readBuff, 0, 256 );
Console.WriteLine("\nThe HTML contents of page the are  : \n\n ");    
while (count > 0) 
{
    String outputData = new String(readBuff, 0, count);
    Console.Write(outputData);
    count = streamRead.Read(readBuff, 0, 256);
}
// Close the Stream object.
streamResponse.Close();
streamRead.Close();
// Release the HttpWebResponse Resource.
myHttpWebResponse.Close();

C++

// Create a new 'HttpWebRequest' Object to the mentioned URL.
HttpWebRequest^ myHttpWebRequest = (HttpWebRequest^)( WebRequest::Create( "http://www.contoso.com"
 ) );
// Assign the response object of 'HttpWebRequest' to a 'HttpWebResponse'
 variable.
HttpWebResponse^ myHttpWebResponse = (HttpWebResponse^)( myHttpWebRequest->GetResponse()
 );
Console::WriteLine( "\nThe HttpHeaders are \n\n\tName\t\tValue\n {0}",
 myHttpWebRequest->Headers );
// Print the HTML contents of the page to the console.
Stream^ streamResponse = myHttpWebResponse->GetResponseStream();
StreamReader^ streamRead = gcnew StreamReader( streamResponse );
array<Char>^ readBuff = gcnew array<Char>(256);
int count = streamRead->Read( readBuff, 0, 256 );
Console::WriteLine( "\nThe HTML contents of page the are  : \n\n " );
while ( count > 0 )
{
   String^ outputData = gcnew String( readBuff,0,count );
   Console::Write( outputData );
   count = streamRead->Read( readBuff, 0, 256 );
}
streamResponse->Close();
streamRead->Close();
// Release the HttpWebResponse Resource.
myHttpWebResponse->Close();

J#

// Create a new 'HttpWebRequest' Object to the mentioned URL.
HttpWebRequest myHttpWebRequest = (HttpWebRequest)
    (WebRequest.Create("http://www.contoso.com"));

// Assign the response object of 'HttpWebRequest' to a 
//'HttpWebResponse' variable.
HttpWebResponse myHttpWebResponse = (HttpWebResponse)
    (myHttpWebRequest.GetResponse());
Console.WriteLine("\nThe HttpHeaders are \n\n\tName\t\tValue\n{0}",
    myHttpWebRequest.get_Headers());
// Print the HTML contents of the page to the console. 
Stream streamResponse = myHttpWebResponse.GetResponseStream();
StreamReader streamRead = new StreamReader(streamResponse);
char readBuff[] = new char[256];
int count = streamRead.Read(readBuff, 0, 256);
Console.WriteLine("\nThe HTML contents of page the are  : \n\n ");
while (count > 0) {
    String outputData = new String(readBuff, 0, count);
    Console.Write(outputData);
    count = streamRead.Read(readBuff, 0, 256);
}

// Close the Stream object.
streamResponse.Close();
streamRead.Close();

// Release the HttpWebResponse Resource.
myHttpWebResponse.Close();

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

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