Metodo IHttpContext::MapHandler

Articolo
07/19/2023

Esegue il mapping di un gestore per l'URL e il verbo HTTP specificati in un sito.

Sintassi

virtual HRESULT MapHandler(  
    DWORD               dwSiteId,  
    PCWSTR              pszSiteName,  
    PCWSTR              pszUrl,  
    PCSTR               pszVerb,  
    IScriptMapInfo **   ppScriptMap,  
    BOOL                fIgnoreWildcardMappings  
) = 0;

Parametri

dwSiteId
[IN] ID del sito che contiene l'URL per il mapping.

pszSiteName
[IN] Puntatore a una stringa contenente il nome del sito per l'URL di destinazione.

pszUrl
[IN] Puntatore a una stringa contenente l'URL relativo per il mapping.

pszVerb
[IN] Puntatore a una stringa contenente il verbo HTTP per il mapping.

ppScriptMap
[OUT] Puntatore all'interfaccia IScriptMapInfo che contiene i dettagli per la mappa di script selezionata.

fIgnoreWildcardMappings
[IN] true per ignorare il mapping con caratteri jolly; in caso contrario, false.

Valore restituito

Oggetto HRESULT. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente.

Valore	Descrizione
S_OK	Indica che l'operazione è riuscita.
ERROR_NOT_ENOUGH_MEMORY	Indica che la memoria non è sufficiente per eseguire l'operazione.

Commenti

L'interfaccia IScriptMapInfo è valida per l'uso per la durata dell'interfaccia IHttpContext .

Esempio

Nell'esempio di codice seguente viene illustrato come usare il MapHandler metodo per creare un modulo HTTP restituito.

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

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Length of the returned path.
            DWORD cbPhysicalPath = 0;
            
            // Get the length of the mapped path.
            pHttpContext->MapPath(L"/",NULL,&cbPhysicalPath);
            
            // Allocate space to store the path.
            PWSTR pwszPhysicalPath =
                (PWSTR) pHttpContext->AllocateRequestMemory(cbPhysicalPath+1);
            PSTR pszPhysicalPath  =
                (PSTR) pHttpContext->AllocateRequestMemory(cbPhysicalPath+1);
            
            // Test for an error.
            if ((pwszPhysicalPath==NULL) || (pszPhysicalPath==NULL))
            {
                // Set the error status.
                pHttpContext->GetResponse()->SetStatus(500,"Server Error",0,
                    HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY));
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
            
            // Retrieve the mapped path.
            pHttpContext->MapPath(L"/",pwszPhysicalPath,&cbPhysicalPath);
            
            // Convert the WCHAR string to a CHAR string.
            wcstombs_s((size_t*)&cbPhysicalPath,pszPhysicalPath,
                cbPhysicalPath,pwszPhysicalPath,cbPhysicalPath);
            
            // 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);

                // Return the path information.
            WriteResponseMessage(pHttpContext,
                "Path: ",pszPhysicalPath);

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

Il modulo deve esportare la funzione RegisterModule . È possibile esportare questa funzione creando un file di definizione del modulo (con estensione def) per il progetto oppure è possibile compilare il modulo usando l'opzione /EXPORT:RegisterModule . Per altre informazioni, vedere Procedura dettagliata: Creazione di un modulo HTTP Request-Level tramite codice nativo.

È possibile compilare il codice usando la __stdcall (/Gz) convenzione di chiamata anziché dichiarare in modo esplicito la convenzione di chiamata per ogni funzione.

Requisiti

Tipo	Descrizione
Client	- IIS 7.0 in Windows Vista - IIS 7.5 in Windows 7 - IIS 8.0 in Windows 8 - IIS 10.0 in Windows 10
Server	- IIS 7.0 in Windows Server 2008 - IIS 7.5 in Windows Server 2008 R2 - IIS 8.0 in Windows Server 2012 - IIS 8.5 in Windows Server 2012 R2 - IIS 10.0 in Windows Server 2016
Prodotto	- 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
Intestazione	Httpserv.h

Vedere anche

Interfaccia IHttpContext
Interfaccia IScriptMapInfo

Condividi tramite