CGlobalModule::OnGlobalFileChange 方法

表示将处理 GlobalFileChange 事件的方法,该事件在网站中的文件发生更改时发生。

语法

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalFileChange(  
   IN IGlobalFileChangeProvider* pProvider  
);  

parameters

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

返回值

GLOBAL_NOTIFICATION_STATUS值。

备注

当全局模块已注册 GL_FILE_CHANGE 事件通知时,当网站范围内的文件发生更改时,IIS 将调用该模块 OnGlobalFileChange 的 方法。

注意

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

IIS 创建 IGlobalFileChangeProvider 接口,并将该接口传递给模块的 OnGlobalFileChange 方法。 开发人员可以使用此接口检索有关已更改的文件的信息。

示例

下面的代码示例演示如何创建一个全局级别 HTTP 模块,该模块使用 IGlobalFileChangeProvider::GetFileName 方法检索已修改的文件的路径。 然后,该模块将文件的路径写入事件查看器中的日志条目。

#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) 而不是为每个函数显式声明调用约定。

要求

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