HttpListenerResponse.AddHeader メソッド

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

HttpListenerResponse.AddHeader メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定したヘッダーと値をこの応答の HTTP ヘッダーに追加します。

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

Visual Basic (宣言)

Public Sub AddHeader ( _
    name As String, _
    value As String _
)

Visual Basic (使用法)

Dim instance As HttpListenerResponse
Dim name As String
Dim value As String

instance.AddHeader(name, value)

C#

public void AddHeader (
    string name,
    string value
)

C++

public:
void AddHeader (
    String^ name, 
    String^ value
)

J#

public void AddHeader (
    String name, 
    String value
)

JScript

public function AddHeader (
    name : String, 
    value : String
)

パラメータ

name

設定する HTTP ヘッダーの名前。

value

name ヘッダーの値。

例外

例外の種類	条件
ArgumentNullException	name が null 参照 (Visual Basic では Nothing) または空の文字列 ("") です。
ArgumentException	指定したヘッダーの指定が許可されていません。 または name または value に無効な文字が含まれています。
ArgumentOutOfRangeException	value の長さが 65,535 文字を超えています。

解説

このメソッドの呼び出しは、Headers プロパティによって返されたコレクションに対して Set メソッドを呼び出すことと同じです。

name で指定されたヘッダーが存在しない場合、このメソッドは Headers プロパティのコレクションに新しいヘッダーを挿入します。コレクション内に name が存在する場合、このメソッドは、既存の値を value で置き換えます。既存の値を置き換えずに既存のヘッダーに値を追加するには、AppendHeader メソッドを使用します。

使用例

このプロパティを使用してヘッダーを追加するコード例を次に示します。

C#

public static void SetExpirationDate(long
 seconds, HttpListenerResponse response)
{
    response.AddHeader("Expires", seconds.ToString());
}

プラットフォーム

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
HttpListenerResponse クラス
HttpListenerResponse メンバ
System.Net 名前空間
HttpListener クラス
HttpListenerContext クラス
HttpListenerRequest クラス
WebHeaderCollection