IHttpModuleFactory::GetHttpModule メソッド

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

CHttpModule クラスのインスタンスを作成します。

構文

virtual HRESULT GetHttpModule(  
   OUT CHttpModule** ppModule,  
   IN IModuleAllocator* pAllocator  
) = 0;

パラメーター

ppModule
[OUT] CHttpModule クラスへの逆参照ポインター。

pAllocator
[IN] IModuleAllocator インターフェイスへのポインター。

戻り値

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

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

注意

モジュールファクトリはメソッドを提供 GetHttpModule するために必要であるため、アプリケーションに応じて戻り値の任意の状態コードを指定できます。少なくとも、成功した完了を GetHttpModule 示すために、メソッドはS_OKを返す必要があります。

解説

IHttpModuleFactory インターフェイスは、クラスのインスタンスをGetHttpModule作成するメソッドをCHttpModule提供する必要があります。 IIS がモジュールのエクスポートされた RegisterModule 関数を呼び出すと、IIS はモジュールファクトリの GetHttpModule メソッドを使用してクラスのインスタンスを作成します CHttpModule 。

例

次のコード例は、単純な "Hello World" HTTP モジュールを作成する方法を示しています。モジュールは、インターフェイスのIHttpModuleFactoryインスタンスを IHttpModuleRegistrationInfo::SetRequestNotifications メソッドに渡し、RQ_BEGIN_REQUEST通知に登録するエクスポートされたRegisterModule関数を定義します。 IIS では、メソッドを GetHttpModule 使用してクラスのインスタンスを CHttpModule 作成し、成功状態を返します。 IIS では、インターフェイスの Terminate メソッドを IHttpModuleFactory 使用して、メモリからファクトリを削除します。

RQ_BEGIN_REQUEST通知がトリガーされると、IIS はモジュールの CHttpModule::OnBeginRequest メソッドを呼び出して現在の要求を処理します。 OnBeginRequest は応答バッファーをクリアし、応答の MIME の種類を変更します。次に、メソッドは、"Hello World" 文字列を含むデータチャンクを作成し、その文字列を Web クライアントに返します。最後に、モジュールは、すべての通知が完了してから終了したことを IIS に通知する状態インジケーターを返します。

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

// Create the module class.
class CHelloWorld : 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 response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // Create a data chunk.
            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 = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,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 CHelloWorldFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

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

        // 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 CHelloWorldFactory,
        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

参照

CHttpModule クラス
 IHttpModuleFactory インターフェイス
 Native-Code HTTP モジュールの設計
 チュートリアル: ネイティブコードを使用したRequest-Level HTTP モジュールの作成

次の方法で共有

IHttpModuleFactory::GetHttpModule メソッド

構文

パラメーター

戻り値

解説

例

要件

参照

フィードバック

その他のリソース