IHttpResponse::SetHeader メソッド

[アーティクル]
07/19/2023

指定した HTTP 応答ヘッダーの値を設定または追加します。

構文

virtual HRESULT SetHeader(  
   IN PCSTR pszHeaderName,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;  
  
virtual HRESULT SetHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;

パラメーター

pszHeaderName
[IN]設定する HTTP ヘッダーの名前を含む文字列へのポインター。

ulHeaderIndex
[IN]設定する HTTP ヘッダーの ID。

pszHeaderValue
[IN]設定するヘッダーの値を含む文字列へのポインター。

cchHeaderValue
[IN]\0 文字を含まないヘッダー値の長さ (文字数)。

fReplace
[IN]既存のヘッダーを上書きするかどうかを指定します。

戻り値

HRESULT。有効な値を次の表に示しますが、これ以外にもあります。

値	説明
S_OK	操作が成功したことを示します。
ERROR_INVALID_DATA	データが無効であることを示します (たとえば、ヘッダー内のデータが長すぎます)。
ERROR_INVALID_PARAMETER	指定したパラメーターが無効であることを示します (たとえば、パラメーターが NULL に設定されています)。
ERROR_NOT_ENOUGH_MEMORY	操作を実行するためのメモリが不足していることを示します。

解説

メソッドは SetHeader 、現在の応答の HTTP ヘッダーの値を設定します。メソッドには 2 つのオーバーロードされたバージョンがあります SetHeader 。 1 つ目では、パラメーターに含まれる文字列を使用してヘッダーを pszHeaderName 指定できます。もう 1 つのオーバーロードでは、パラメーターに含まれる符号なし長整数が ulHeaderIndex 使用されます。

注意

パラメーターを使用 ulHeaderIndex してヘッダーの値を設定するオーバーロードは使用しないでください。これは、値が既存の Server ヘッダー値に追加されるためです。代わりにパラメーターを pszHeaderName 使用してください。

パラメーターで pszHeaderName 指定するヘッダー名は、カスタムヘッダー、またはコメント要求 (RFC) 1945、"ハイパーテキスト転送プロトコル -- HTTP/1.0"、または RFC 2616、"ハイパーテキスト転送プロトコル -- HTTP/1.1" で定義されたヘッダーです。

注意

パラメーターを pszHeaderName NULL にすることはできません。

パラメーターは ulHeaderIndex 、列挙にリストされている HTTP ヘッダーの ID を HTTP_HEADER_ID 指定します。

注意

列挙体は HTTP_HEADER_ID 、Http.h ヘッダーファイルで定義されています。

パラメーターが fReplace の場合、 trueヘッダーが存在する場合は、指定したヘッダー値によって既存のヘッダー値が置き換えられます。が falseの場合fReplace、指定したヘッダー値を既存のヘッダーに追加し、ヘッダー自体からコンマで区切る必要があります。

注意

他のモジュールまたはハンドラーでは、メソッドを SetHeader 呼び出して値を置き換えたり、指定した値に値を追加したりすることができます。

例

次のコード例では、メソッドの両方の SetHeader オーバーロードを使用して、HTTP Content-Type と Server ヘッダーをカスタム値に置き換え、HTTP Refresh ヘッダーを特定の秒数に設定する方法を示します。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Set the "Refresh" header name.
        char szRefreshName[] = "Refresh";
        // Set the "Refresh" header value.
        char szRefreshValue[] = "30";
        // Set the "Content-Type" header value.
        char szContentType[] = "text/plain";
        // Set the "Server" header value.
        char szServerValue[] = "MyServer/7.0";

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {

            // Set the "Refresh" header.
            hr = pHttpResponse->SetHeader(
                szRefreshName,szRefreshValue,
                (USHORT)strlen(szRefreshValue),FALSE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Content-Type" header.
            hr = pHttpResponse->SetHeader(
                HttpHeaderContentType,szContentType,
                (USHORT)strlen(szContentType),TRUE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Server" header.
            hr = pHttpResponse->SetHeader(
                "Server",szServerValue,
                (USHORT)strlen(szServerValue),TRUE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }
            
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_SEND_RESPONSE,
        0
    );
}

モジュールで RegisterModule 関数をエクスポートする必要があります。この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。詳細については、「チュートリアル: ネイティブコードを使用したRequest-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

Type	説明
Client	- Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 上の IIS 8.0 - Windows 10の IIS 10.0
サーバー	- Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 の IIS 7.5 - Windows Server 2012 の IIS 8.0 - Windows Server 2012 R2 の IIS 8.5 - Windows Server 2016の IIS 10.0
製品	- IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0 - IIS Express 7.5、IIS Express 8.0、IIS Express 10.0
Header	Httpserv.h

参照

IHttpResponse インターフェイス
 IHttpResponse::D eleteHeader メソッド
 IHttpResponse::GetHeader メソッド

次の方法で共有

IHttpResponse::SetHeader メソッド

構文

パラメーター

戻り値

解説

例

要件

参照

フィードバック

その他のリソース