IHttpContext::SetRequestHandled メソッド

現在の要求のハンドラーが完了したことを示します。

構文

virtual VOID SetRequestHandled(  
   VOID  
) = 0;  

パラメーター

このメソッドは、パラメーターを受け取りません。

戻り値

VOID.

注釈

メソッドは SetRequestHandled 、現在の要求のハンドラーが処理を完了したことを指定します。 たとえば、特定のファイルの種類に対して複数の要求ハンドラーが構成されている場合は、 メソッドを SetRequestHandled 使用して、現在の要求の処理が完了し、追加のハンドラーを実行しないことを示すことができます。

例

次のコード例では、次のタスクを実行する HTTP モジュールを作成する方法を示します。

1. モジュールは 、RQ_PRE_EXECUTE_REQUEST_HANDLER 通知に登録します。

2. モジュールは、OnPreExecuteRequestHandler メソッドを含む CHttpModule クラスを作成します。

3. Web クライアントが URL を要求すると、IIS はモジュールの OnPreExecuteRequestHandler メソッドを呼び出します。 このメソッドは、次のタスクを実行します

   1. IScriptMapInfo インターフェイスへのポインターを取得します。

   2. IScriptMapInfo::GetScriptProcessor メソッドを使用して、要求のスクリプト ハンドラーを取得します。

   3. 要求が ASP ページ用の場合は、要求が処理されたことを示すメッセージを Web クライアントに返し、 メソッドを SetRequestHandled 呼び出して要求を処理済みとして設定します。

4. モジュールは、 クラスを CHttpModule メモリから削除してから終了します。

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

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

        // Retrieve an IScriptMapInfo interface.
        IScriptMapInfo * pScriptMapInfo = pHttpContext->GetScriptMap();

        // Test for an error.
        if (NULL != pScriptMapInfo)
        {
            // Create buffers to store the script processor path.
            PCWSTR pwszScriptProcessor;
            DWORD  cchScriptProcessor = 0;

            // Retrieve the script processor.
            pwszScriptProcessor =
                pScriptMapInfo->GetScriptProcessor(&cchScriptProcessor);

            // Test for an error.
            if ((pwszScriptProcessor != NULL) && (cchScriptProcessor > 0))
            {
                // Test for an ASP request.
                if (NULL != wcsstr(pwszScriptProcessor,L"\\asp.dll"))
                {
                    // Clear the existing response.
                    pHttpContext->GetResponse()->Clear();
                    // Set the MIME type to plain text.
                    pHttpContext->GetResponse()->SetHeader(
                        HttpHeaderContentType,"text/plain",
                        (USHORT)strlen("text/plain"),TRUE);
                    // Return a status message.
                    WriteResponseMessage(pHttpContext,
                        "ASP requests have been handled.");
                    // Indicate that handlers for this request have completed.
                    pHttpContext->SetRequestHandled();                    
                }
            }
        }         
        // Return processing to the pipeline.    
        return RQ_NOTIFICATION_CONTINUE;
    }

private:

    // Create a utility method that inserts a string value into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszBuffer
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk. (Defined in the Http.h file.)
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszBuffer;
        // Set the chunk size to the buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszBuffer);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// 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 we 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_PRE_EXECUTE_REQUEST_HANDLER,
        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

参照

IHttpContext インターフェイス