IHttpContext::MapPath, méthode

Retourne le chemin physique d’une URL relative.

Syntaxe

virtual HRESULT MapPath(  
   PCWSTR pszUrl,  
   __out_bcount(* pcbPhysicalPath) PWSTR pszPhysicalPath,  
   DWORD* pcbPhysicalPath  
) = 0;  

Paramètres

pszUrl
[IN] Pointeur vers une chaîne qui contient l’URL relative à mapper.

pszPhysicalPath
[OUT] Pointeur vers une chaîne qui reçoit le chemin mappé.

pcbPhysicalPath
[IN] Pointeur vers un DWORD qui contient la taille de la mémoire tampon pointée vers .pszPhysicalPath

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Valeur	Description
S_OK	Indique que l’opération a réussi.
ERROR_INSUFFICIENT_BUFFER	Indique que la mémoire tampon pointée par pszPhysicalPath n’est pas assez grande pour effectuer l’opération.
ERROR_NOT_ENOUGH_MEMORY	Indique que la mémoire est insuffisante pour effectuer l’opération.

Remarques

La MapPath méthode retourne l’emplacement physique de l’URL relative contenue dans le pszUrl paramètre.

Notes

Si la mémoire tampon pointée par le pszPhysicalPath paramètre n’est pas assez grande pour effectuer l’opération, le pcbPhysicalPath``DWORD paramètre contient la taille de mémoire tampon requise pour l’opération.

Exemple

L’exemple de code suivant montre comment utiliser la MapPath méthode pour créer un module HTTP qui retourne le chemin physique du dossier racine pour le site web qui utilise ce module.

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

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

IHttpContext, interface