CGlobalModule：：OnGlobalConfigurationChange 方法

表示将处理 GlobalConfigurationChange 事件的方法，该事件在对配置文件进行更改时发生。

语法

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalConfigurationChange(  
   IN IGlobalConfigurationChangeProvider* pProvider  
);  

parameters

pProvider
[IN]指向 IGlobalConfigurationChangeProvider 接口的 指针。

返回值

GLOBAL_NOTIFICATION_STATUS值。

备注

当全局模块已注册 GL_CONFIGURATION_CHANGE 事件通知时，如果配置文件发生更改，IIS 将调用模块 OnGlobalConfigurationChange 的 方法。 例如，如果更改了ApplicationHost.config文件，则包含配置路径的事件将写入事件查看器。

注意

全局模块可以通过在模块的 GlobalConfigurationChangeRegisterModule 函数中注册 来GL_CONFIGURATION_CHANGE注册事件通知。

示例

下面的代码示例演示如何创建一个全局级别 HTTP 模块，该模块使用 IGlobalConfigurationChangeProvider：：GetChangePath 方法检索配置更改的路径，并将日志条目添加到事件查看器。

#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
    OnGlobalConfigurationChange(
        IN IGlobalConfigurationChangeProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Test for an error.
        if (NULL != m_pHttpContext)
        {
            // Retrieve the path that has changed.
            PCWSTR pwszChangePath = NULL;
            pwszChangePath = pProvider->GetChangePath();
            // Test for an error.
            if (NULL != pwszChangePath)
            {
                // Allocate storage for the path.
                char * pszChangePath =
                    (char *) m_pHttpContext->AllocateRequestMemory(
                    (DWORD) wcslen(pwszChangePath)+1 );
                // Test for an error.
                if (NULL != pszChangePath)
                {
                    // Convert the path.
                    wcstombs(pszChangePath,pwszChangePath,
                        wcslen(pwszChangePath));
                    // Create an array of strings.
                    LPCSTR szBuffer[2] = {"Path Changed"};
                    // Store the path.
                    szBuffer[1] = pszChangePath;
                    // 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
    )
    {
        UNREFERENCED_PARAMETER( 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_CONFIGURATION_CHANGE | GL_PRE_BEGIN_REQUEST );
}

模块必须导出 RegisterModule 函数。 可以通过为项目创建模块定义 (.def) 文件导出此函数，也可以使用 开关编译模块 /EXPORT:RegisterModule 。 有关详细信息，请参阅 演练：使用本机代码创建Global-Level HTTP 模块。

可以选择使用调用约定编译代码， __stdcall (/Gz) 而不是为每个函数显式声明调用约定。

要求

类型	说明
客户端	- 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

另请参阅

CGlobalModule 类
IGlobalConfigurationChangeProvider 接口