チュートリアル: ネイティブコードを使用したGlobal-Level HTTP モジュールの作成

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

このチュートリアルでは、C++ を使用して、IIS 7 で新しい要求処理アーキテクチャを実装するサンプルのグローバルレベル HTTP モジュールを作成する方法を示します。この新しいアーキテクチャは、以前のバージョンの ASP.NET HTTP モジュールと ISAPI フィルターまたは拡張機能を使用して IIS アプリケーションを記述する場合に、ネイティブコードプログラミングの機能を拡張します。新しい要求処理アーキテクチャを使用した HTTP モジュールの設計の詳細については、「 Native-Code HTTP モジュールの設計」を参照してください。

このチュートリアルでは、HTTP モジュール用の C++ プロジェクトを作成し、"Hello World" プロジェクトに必要なコードを追加してから、モジュールをコンパイルしてテストします。

必須コンポーネント

この例の手順を完了するには、次のソフトウェアが必要です。

IIS 7。
Visual Studio 2005:

注意

Visual Studio .NET 2003 以前を使用することもできますが、チュートリアルの手順は同じではない可能性があります。

モジュールの作成

チュートリアルのこの部分では、HTTP モジュール用に空の C++ DLL プロジェクトを作成します。

新しい C++ DLL プロジェクトを作成するには

Visual Studio 2005 を起動します。
グローバルオプションに SDK インクルードファイルへの適切なパスがすべて含まれることを確認します。
1. [ツール] メニューの [オプション] をクリックします。
2. ツリービューで [ プロジェクトとソリューション] ノードを展開し、[ VC++ ディレクトリ] をクリックします。
3. [ ディレクトリを表示する] ドロップダウンボックスで、[ ファイルを含める] を選択します。
4. SDK インクルードファイルをインストールしたパスが一覧表示されていることを確認します。パスが一覧にない場合は、[ 改行 ] アイコンをクリックし、SDK インクルードファイルをインストールしたパスを追加します。
5. [OK] をクリックします。
新しい C++ プロジェクトを作成します。
1. [ファイル] メニューの [新規作成] をポイントし、 [プロジェクト] をクリックします。
  
  [新しいプロジェクト] ダイアログボックスが表示されます。
2. [ プロジェクトの種類 ] ウィンドウで、[ Visual C++ ] ノードを展開し、[ Win32] をクリックします。
3. [テンプレート] ウィンドウで、[ Win32 プロジェクト] を選択します。
4. [ 名前 ] ボックスに 「HelloWorld」と入力します。
5. [ 場所 ] ボックスに、サンプルのパスを入力します。
6. [OK] をクリックします。
  
  Win32 アプリケーションウィザードが開きます。
7. [ アプリケーションの設定] をクリックします。
8. [ アプリケーションの種類] で、[ DLL] をクリックします。
9. [ その他のオプション] で、[ プロジェクトを空にする] をクリックします。
10. [完了] をクリックします。

コードファイルとソースファイルの追加

次の手順では、必要な C++ ファイルとモジュール定義ファイルをプロジェクトに追加します。

ソースファイルをプロジェクトに追加するには

RegisterModule 関数をエクスポートするモジュール定義ファイルを作成します。
1. ソリューションエクスプローラーで、[ソースファイル] を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。
  
  [新しい項目の追加] ダイアログボックスが開きます。
2. [カテゴリ] ウィンドウで [Visual C++] ノードを展開し、[コード] をクリックします。
3. [テンプレート] ペインで、[ モジュール定義ファイル ] テンプレートを選択します。
4. [ 名前 ] ボックスに 「HelloWorld」と入力し、[ 場所 ] ボックスにファイルの既定のパスをそのまま使用します。
5. [追加] をクリックします。
6. 次のコードを追加します。
```
LIBRARY HelloWorld  

EXPORTS  
    RegisterModule  
```
必要に応じて、/EXPORT:RegisterModule スイッチを使用して RegisterModule 関数をエクスポートできます。
1. [ プロジェクト ] メニューの [ HelloWorld のプロパティ] をクリックします。
2. ツリービューで [構成プロパティ ] ノードを展開し、[ リンカー ] ノードを展開して、[ コマンドライン] をクリックします。
3. [ 構成 ] ドロップダウンボックスで、[ すべての構成] を選択します。
4. [ 追加のオプション] ボックスに、「 /EXPORT:RegisterModule」と入力します。
5. [OK] をクリックします。

C++ ファイルを作成します。

ソリューションエクスプローラーで、[ソースファイル] を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。

[新しい項目の追加] ダイアログボックスが開きます。
[カテゴリ] ウィンドウで [Visual C++] ノードを展開し、[コード] をクリックします。
[テンプレート] ペインで、 C++ ファイル テンプレートを選択します。
[ 名前 ] ボックスに 「HelloWorld」と入力し、[ 場所 ] ボックスにファイルの既定のパスをそのまま使用します。
[追加] をクリックします。

次のコードを追加します。

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:

    // Process a GL_APPLICATION_START notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog( "Hello World!" );
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

    MyGlobalModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyGlobalModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog,
                EVENTLOG_INFORMATION_TYPE, 0, 0,
                NULL, 1, 0, &szNotification, NULL );
        }
        return FALSE;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
    // Set the global notifications and exit.
    return pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_PRE_BEGIN_REQUEST );
}

必要に応じて、呼び出し規約を使用してコードを __stdcall (/Gz) コンパイルできます。
1. [ プロジェクト ] メニューの [ HelloWorld のプロパティ] をクリックします。
2. ツリービューで [ 構成プロパティ ] ノードを展開し、[ C/C++ ] ノードを展開して、[ 詳細設定] をクリックします。
3. [ 構成 ] ドロップダウンボックスで、[ すべての構成] を選択します。
4. [ 呼び出し規約 ] ドロップダウンボックスで、 __stdcall (/Gz) を選択します。
5. [OK] をクリックします。

モジュールのコンパイルとテスト

HTTP モジュールには、必要なものがすべて含まれています。必要なのは、HTTP モジュールをコンパイルしてテストすることです。

プロジェクトをコンパイルしてテストするには

HTTP モジュールをコンパイルします。
1. [ビルド] メニューの [ソリューションのビルド] をクリックします。
2. Visual Studio でエラーや警告が返されなかったことを確認します。エラーまたは警告が発生した場合は、プロジェクトをテストする前に、これらの問題を解決する必要があります。
HTTP モジュールの DLL ファイルを IIS フォルダーにコピーします。
1. Windows エクスプローラーを開き、C++ プロジェクトの作成時に指定された既定のフォルダーを見つけます。
  
  ビルドオプションに応じて、プロジェクトの既定のフォルダーに Debug または Release という名前のフォルダーが表示されます。
2. [デバッグ] フォルダーまたは [リリース] フォルダー内で、HelloWorld.dll という名前のファイルを見つけます。
3. HelloWorld.dll ファイルを Inetsrv フォルダーにコピーします。既定では %WinDir%\System32\Inetsrv にあります。
HelloWorld.dll モジュールをモジュールの一覧に追加します (手順については、「 Native-Code HTTP モジュールの設計」を参照してください)。
インターネットエクスプローラーを使用して Web サイトを参照します。通常の Web サイトコンテンツが表示されます。
Windows イベントビューアーを開き、グローバルアプリケーションログに切り替えます。イベントソースとして "IISADMIN" を一覧表示するエントリが表示されます。
イベントを右クリックし、[ プロパティ ] をクリックしてイベントの詳細を表示します。 [説明] ウィンドウに "Hello World!" というメッセージが表示されます。

設定のトラブルシューティング

モジュールがコンパイルされない場合、または期待どおりに動作しない場合は、次の領域をチェックできます。

エクスポートした関数に対してを指定 __stdcall したか、呼び出し規則を使用してコンパイルを __stdcall (/Gz) 構成していることを確認します。
定義ファイルに正しい RegisterModule エクスポートが追加されていることを確認します。
定義ファイルがプロジェクト設定に追加されていることを確認します。プロジェクト設定にファイルを追加するには、次の手順を実行します。
1. [プロジェクト] メニューの [プロパティ] をクリックします。
2. ツリービューで [ 構成プロパティ] ノードを展開し、[ リンカー ] ノードを展開して、[ 入力] をクリックします。
3. [ モジュール定義ファイル] 設定で、定義ファイルが一覧表示されていることを確認します。

次の方法で共有

チュートリアル: ネイティブコードを使用したGlobal-Level HTTP モジュールの作成

必須コンポーネント

モジュールの作成

新しい C++ DLL プロジェクトを作成するには

コードファイルとソースファイルの追加

ソースファイルをプロジェクトに追加するには

モジュールのコンパイルとテスト

プロジェクトをコンパイルしてテストするには

設定のトラブルシューティング

関連項目

フィードバック

その他のリソース

次の方法で共有

チュートリアル: ネイティブ コードを使用したGlobal-Level HTTP モジュールの作成

必須コンポーネント

モジュールの作成

新しい C++ DLL プロジェクトを作成するには

コード ファイルとソース ファイルの追加

ソース ファイルをプロジェクトに追加するには

モジュールのコンパイルとテスト

プロジェクトをコンパイルしてテストするには

設定のトラブルシューティング

関連項目

フィードバック

その他のリソース

チュートリアル: ネイティブコードを使用したGlobal-Level HTTP モジュールの作成

コードファイルとソースファイルの追加

ソースファイルをプロジェクトに追加するには