IHttpRequest::D eleteHeader メソッド

要求から HTTP ヘッダーを削除します。

構文

virtual HRESULT DeleteHeader(  
   IN PCSTR pszHeaderName  
) = 0;  
  
virtual HRESULT DeleteHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex  
) = 0;  

パラメーター

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

ulHeaderIndex
[IN] HTTP_HEADER_ID 削除する HTTP ヘッダーの ID を指定する 値。

戻り値

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

値	説明
S_OK	操作が成功したことを示します。

解説

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

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

注意

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

パラメーターは ulHeaderIndex 、列挙にリストされている HTTP_HEADER_ID HTTP ヘッダーの ID を指定します。この ID には、いくつかの一般的な HTTP ヘッダーが含まれています。

注意

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

例

次のコード例は、 メソッドの両方のバージョンを使用して、 DeleteHeader と Accept-Language HTTP ヘッダーを要求から削除User-Agentする HTTP モジュールを作成する方法を示しています。

#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;

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

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Delete the "User-Agent" header.
            hr = pHttpRequest->DeleteHeader("User-Agent");
            // test for an error
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
            // Delete the "Accept-language" header.
            // (Use values from HTTP_HEADER_ID in the Http.h file.)
            hr = pHttpRequest->DeleteHeader(HttpHeaderAcceptLanguage);
            // 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_BEGIN_REQUEST,
        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

参照

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