IHttpSite::GetSiteName, méthode

Récupère le nom du site web.

Syntaxe

virtual PCWSTR GetSiteName(  
   VOID  
) const = 0;  

Paramètres

Cette méthode ne prend aucun paramètre.

Valeur renvoyée

Pointeur vers une chaîne qui contient le nom du site web.

Notes

La GetSiteName méthode retourne le nom du site web qui traite la demande actuelle. Le nom qui GetSiteName retourne est le même nom qui s’affiche dans le Gestionnaire des services Internet et est créé ou modifié par un administrateur web lorsqu’il crée ou gère un site web.

Exemple

L’exemple de code suivant montre comment utiliser la GetSiteName méthode pour créer un module HTTP qui récupère une interface IHttpSite . Le module utilise GetSiteName pour récupérer le nom du site Web pour la demande actuelle. Le module retourne ensuite le nom du site web à un client Web et se ferme.

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

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

        // Buffers for string variables.
        PCWSTR pwszSiteName = NULL;
        char * pszSiteName = NULL;

        // Retrieve a pointer to an IHttpSite class.
        IHttpSite * pHttpSite = pHttpContext->GetSite();

        if (NULL != pHttpSite)
        {
            // Retrieve the site name.
            pwszSiteName = pHttpSite->GetSiteName();
            // Test for an error.
            if (NULL != pwszSiteName)
            {
                // Clear the existing buffer.
                pHttpContext->GetResponse()->Clear();
                // Convert the site string.
                pszSiteName =
                    (char*) pHttpContext->AllocateRequestMemory(
                    (DWORD) wcslen(pwszSiteName)+1 );
                if (NULL != pszSiteName)
                {
                    wcstombs(pszSiteName,pwszSiteName,
                        wcslen(pwszSiteName));
                    // Return the site information.
                    WriteResponseMessage(pHttpContext,
                        "Site Name: ",pszSiteName);
                    // 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 );
    UNREFERENCED_PARAMETER( 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.

Configuration requise

 Voir aussi

IHttpContext::GetSite, méthode
IHttpSite Interface
IHttpSite::GetSiteId, méthode