IHttpRequest::SetHeader メソッド

指定した 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] true 既存のヘッダーを上書きする場合は 。それ以外の場合は false。

戻り値

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

解説

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

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

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

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

例

次のコード例では、 メソッドの両方のオーバーロードをSetHeader使用して、HTTP とAccept-Languageヘッダーを新しい値に置き換える HTTP User-Agent モジュールを作成する方法を示します。

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

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

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Specify the "User-Agent" header name.
        char szHeaderName[] = "User-Agent";
        // Specify the "User-Agent" header value.
        char szUserAgent[] = "Test Browser";
        // Specify the "Accept-Language" header value.
        char szAcceptLanguage[] = "en-ie";

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Replace the "User-Agent" header.
            hr = pHttpRequest->SetHeader(
                szHeaderName,szUserAgent,
                (USHORT)strlen(szUserAgent),true);

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

            // Replace the "Accept-language" header.
            hr = pHttpRequest->SetHeader(
                HttpHeaderAcceptLanguage,szAcceptLanguage,
                (USHORT)strlen(szAcceptLanguage),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;
        }            
    }
/* MERGEFORMAT 16 Aug 07  5:41 PM */
    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_BEGIN_REQUEST,
        0
    );
}

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

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

要件

参照

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