IHttpContext::MapPath (Método)

Devuelve la ruta de acceso física de una dirección URL relativa.

Sintaxis

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

Parámetros

pszUrl
[IN] Puntero a una cadena que contiene la dirección URL relativa que se va a asignar.

pszPhysicalPath
[OUT] Puntero a una cadena que recibe la ruta de acceso asignada.

pcbPhysicalPath
[IN] Puntero a un DWORD objeto que contiene el tamaño del búfer al que pszPhysicalPathapunta .

Valor devuelto

Una clase HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Valor	Descripción
S_OK	Indica que la operación se realizó correctamente.
ERROR_INSUFFICIENT_BUFFER	Indica que el búfer al pszPhysicalPath que apunta no es lo suficientemente grande como para realizar la operación.
ERROR_NOT_ENOUGH_MEMORY	Indica que no hay memoria suficiente para realizar la operación.

Comentarios

El MapPath método devuelve la ubicación física de la dirección URL relativa contenida en el pszUrl parámetro .

Nota

Si el búfer al que apunta el pszPhysicalPath parámetro no es lo suficientemente grande como para realizar la operación, el pcbPhysicalPath``DWORD parámetro contendrá el tamaño de búfer necesario para la operación.

Ejemplo

En el ejemplo de código siguiente se muestra cómo usar el MapPath método para crear un módulo HTTP que devuelva la ruta de acceso física de la carpeta raíz del sitio web que usa este módulo.

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

El módulo debe exportar la función RegisterModule . Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.

Puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.

Requisitos

Tipo	Descripción
Remoto	- IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10
Servidor	- IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016
Producto	- 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
Encabezado	Httpserv.h

Consulte también

IHttpContext (interfaz)