CGlobalModule::OnGlobalConfigurationChange, méthode

Article
07/19/2023

Représente la méthode qui gère un GlobalConfigurationChange événement, qui se produit lorsqu’une modification est apportée à un fichier de configuration.

Syntaxe

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalConfigurationChange(  
   IN IGlobalConfigurationChangeProvider* pProvider  
);

Paramètres

pProvider
[IN] Pointeur vers une interface IGlobalConfigurationChangeProvider .

Valeur renvoyée

Valeur GLOBAL_NOTIFICATION_STATUS .

Remarques

Lorsqu’un module global s’est inscrit pour la notification d’événement GL_CONFIGURATION_CHANGE , IIS appelle la méthode du OnGlobalConfigurationChange module si un fichier de configuration est modifié. Par exemple, si le fichier ApplicationHost.config est modifié, un événement contenant le chemin de configuration est écrit dans le observateur d'événements.

Notes

Les modules globaux peuvent s’inscrire à la GlobalConfigurationChange notification d’événement en s’inscrivant à GL_CONFIGURATION_CHANGE dans la fonction RegisterModule du module.

Exemple

L’exemple de code suivant montre comment créer un module HTTP de niveau global qui utilise la méthode IGlobalConfigurationChangeProvider::GetChangePath pour récupérer le chemin d’accès d’une modification de configuration et ajouter une entrée de journal au observateur d'événements.

#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 );
}

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur. Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Global-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

Spécifications

Type	Description
Client	- IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10
Serveur	- IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016
Produit	- 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
En-tête	Httpserv.h

Voir aussi

CGlobalModule, classe
IGlobalConfigurationChangeProvider, interface

Partager via