IHttpContext::GetMetadata メソッド

現在の要求コンテキストのメタデータ コンテナーを取得します。

構文

virtual IMetadataInfo* GetMetadata(  
   VOID  
) = 0;  

パラメーター

このメソッドはパラメーターを受け取っていません。

戻り値

IMetadataInfo インターフェイスへのポインター。

注釈

GetMetadata メソッドは、現在のコンテキストの IIS 7 構成ファイルから情報を取得するために使用するIMetadataInfo インターフェイスを取得します。 その後、IMetadataInfo インターフェイスから GetMetaPath メソッドを使用して、現在の要求コンテキストの構成パスを取得できます。

例

次のコード例では、 GetMetadata メソッドを使用して IMetadataInfo インターフェイスへのポインターを取得する HTTP モジュールを作成する方法を示します。 モジュールは、次の手順を完了します。

1. IMetadataInfo::GetMetaPath メソッドを使用して、現在の要求の構成パスを取得します。

2. IHttpServer::GetConfigObject メソッドを使用して、INativeConfigurationSystem インターフェイスへのポインターを取得します。

3. 現在の要求の構成パスを INativeConfigurationSystem::GetConfigSection メソッドに渡します。

4. IIS のログ設定の INativeConfigurationElement インターフェイスを取得します。

5. INativeConfigurationElement::GetBooleanProperty メソッドを使用して、現在の要求コンテキストでログ記録が有効になっているかどうかを示す値を取得します。

6. この情報を Web クライアントに返し、終了します。

#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( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );

        // 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 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 );

    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST | RQ_SEND_RESPONSE,
        0
    );
}

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

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

必要条件

こちらもご覧ください

IHttpContext インターフェイス