CGlobalModule::OnGlobalFileChange メソッド

Web サイト内のファイルが変更されたときに発生するイベントを処理 GlobalFileChange するメソッドを表します。

構文

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalFileChange(  
   IN IGlobalFileChangeProvider* pProvider  
);  

パラメーター

pProvider
[IN] IGlobalFileChangeProvider インターフェイスへのポインター。

戻り値

GLOBAL_NOTIFICATION_STATUS値。

解説

グローバル モジュールが GL_FILE_CHANGE イベント通知に登録されている場合、IIS は、Web サイトのスコープ内の OnGlobalFileChange ファイルが変更されると、モジュールの メソッドを呼び出します。

IIS は IGlobalFileChangeProvider インターフェイスを作成し、 インターフェイスをモジュールの OnGlobalFileChange メソッドに渡します。 開発者は、このインターフェイスを使用して、変更されたファイルに関する情報を取得できます。

例

次のコード例では、 IGlobalFileChangeProvider::GetFileName メソッドを使用して、変更されたファイルへのパスを取得するグローバル レベルの HTTP モジュールを作成する方法を示します。 その後、モジュールはファイルのパスをイベント ビューアーのログ エントリに書き込みます。

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalFileChange(
        IN IGlobalFileChangeProvider * pProvider
    )
    {
        // Test for an error.
        if (NULL != m_pHttpContext)
        {
            // Retrieve the file name.
            PCWSTR pwszFileName = pProvider->GetFileName();
            // Test for an error.
            if (NULL != pwszFileName)
            {
                // Allocate storage for the file name.
                char * pszFileName =
                    (char *) m_pHttpContext->AllocateRequestMemory(
                    (DWORD) wcslen(pwszFileName)+1 );
                // Test for an error.
                if (NULL != pszFileName)
                {
                    // Convert the file name.
                    wcstombs(pszFileName,pwszFileName,
                        wcslen(pwszFileName));
                    // Create an array of strings.
                    LPCSTR szBuffer[2] = {"File Name"};
                    // Store the file name.
                    szBuffer[1] = pszFileName;
                    // Write the strings to the Event Viewer.
                    WriteEventViewerLog(szBuffer,2);
                }
            }
        }
        // Return processing to the pipeline.
        return GL_NOTIFICATION_CONTINUE;
    }

    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        // Retrieve a pointer to the context.
        m_pHttpContext = pProvider->GetHttpContext();
        // Return processing to the pipeline.
        return GL_NOTIFICATION_CONTINUE;
    }

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

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

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

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;
    // Create a pointer for the module context.
    IHttpContext * m_pHttpContext;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != MyGlobalModule::m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                MyGlobalModule::m_hEventLog,
                EVENTLOG_INFORMATION_TYPE,
                0, 0, NULL, wNumStrings,
                0, szBuffer, 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_FILE_CHANGE | GL_PRE_BEGIN_REQUEST );
}

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

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

要件

参照

CGlobalModule クラス