IHttpServer::GetConfigObject, méthode

Article
07/19/2023

Récupère l’objet de configuration pour le contexte actuel.

Syntaxe

virtual INativeConfigurationSystem* GetConfigObject(  
   VOID  
) const = 0;

Paramètres

Cette méthode ne prend aucun paramètre.

Valeur renvoyée

Pointeur vers une interface INativeConfigurationSystem .

Remarques

La GetConfigObject méthode récupère un objet de configuration que vous pouvez utiliser pour récupérer les paramètres de configuration à partir d’un fichier de configuration. Par exemple, la méthode INativeConfigurationSystem::GetConfigSection récupère une interface INativeConfigurationElement , qui est un objet conteneur pour une section des paramètres de configuration du contexte actuel. Cet objet conteneur contient plusieurs méthodes que vous pouvez utiliser pour récupérer ou modifier les paramètres de configuration.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui utilise la méthode IHttpContext::GetMetadata pour récupérer un pointeur vers une interface IMetadataInfo . Le module effectue les étapes suivantes :

Utilise la méthode IMetadataInfo::GetMetaPath pour récupérer le chemin de configuration de la requête actuelle.
Utilise la GetConfigObject méthode pour récupérer un pointeur vers une INativeConfigurationSystem interface.
Transmet le chemin de configuration de la demande actuelle à la INativeConfigurationSystem::GetConfigSection méthode .
Récupère une INativeConfigurationElement interface pour les paramètres de journal pour IIS.
Utilise la méthode INativeConfigurationElement::GetBooleanProperty pour récupérer une valeur qui indique si la journalisation est activée pour le contexte de requête actuel.
Retourne ces informations à un client Web, puis se ferme.

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

// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        // Create a boolean variable for the configuration setting.
        BOOL fDoNotLog = FALSE;
        // Create pointers to configuration objects.
        INativeConfigurationSystem * pConfigSystem = NULL;
        INativeConfigurationElement * pConfigElement = NULL;

        // Retrieve a pointer to the IMetadataInfo interface.
        IMetadataInfo * pMetadataInfo = pHttpContext->GetMetadata();
        
        // Retrieve the configuration path.
        PCWSTR pwszConfigPath = pMetadataInfo->GetMetaPath();

        // Retrieve the configuration object.
        pConfigSystem = g_pHttpServer->GetConfigObject();

        // Test for an error.
        if (NULL != pConfigSystem)
        {        
            // Retrieve the HTTP logging configuration section.
            hr = pConfigSystem->GetConfigSection(
                L"system.webServer/httpLogging",
                pwszConfigPath,&pConfigElement,NULL,NULL);
        
            // Test for an error.
            if (SUCCEEDED(hr))
            {
                // Retrieve the log settings from the configuration section.
                hr = pConfigElement->GetBooleanProperty(
                    L"dontLog",&fDoNotLog,NULL);

                // Test for an error.
                if (SUCCEEDED(hr))
                {
                    // Clear the existing response.
                    pHttpContext->GetResponse()->Clear();
                    // Set the MIME type to plain text.
                    pHttpContext->GetResponse()->SetHeader(
                        HttpHeaderContentType,"text/plain",
                        (USHORT)strlen("text/plain"),TRUE);
                            
                    // Allocate space for the configuration path.
                    PSTR pszConfigPath =
                        (PSTR) pHttpContext->AllocateRequestMemory(
                        (DWORD) wcslen(pwszConfigPath) + 1 );

                    // Test for an error.
                    if (NULL == pszConfigPath)
                    {
                        // Set the error status.
                        hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                        pProvider->SetErrorStatus( hr );
                        // End additional processing.
                        return RQ_NOTIFICATION_FINISH_REQUEST;
                    }

                    // Convert the WCHAR string to a CHAR string.
                    wcstombs(pszConfigPath,
                        pwszConfigPath,wcslen(pwszConfigPath));

                    // Return the configuration path.
                    WriteResponseMessage(pHttpContext,
                        "\nConfiguration path:\t",pszConfigPath);

                    // Return the configuration setting.
                    WriteResponseMessage(pHttpContext,"\nLogging enabled:\t",
                        (FALSE == fDoNotLog) ? "Yes" : "No");

                    // End additional processing.
                    return RQ_NOTIFICATION_FINISH_REQUEST;
                }
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk.
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

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

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

    // Store the pointer for the global server interface.
    g_pHttpServer = pGlobalInfo;

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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 Request-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

IHttpServer Interface

Partager via