IMapPathProvider::GetPhysicalPath-Methode

Ruft den physischen Pfad für die aktuelle Anforderung ab.

Syntax

virtual PCWSTR GetPhysicalPath(  
) const = 0;  

Die Parameter

Diese Methode akzeptiert keine Parameter.

Rückgabewert

Ein Zeiger auf eine Zeichenfolge, die den physischen Pfad enthält.

Bemerkungen

Die GetPhysicalPath Methode ruft den Pfad für die aktuelle Anforderung ab, wenn ein HTTP-Modul das CHttpModule::OnMapPath-Ereignis verarbeitet.

Hinweis

Der pfad, der von der GetPhysicalPath Methode zurückgegeben wird, wird nicht in den physischen Pfad übersetzt, der die tatsächliche Antwort bereitstellt. Wenn beispielsweise die Standardstartseite für eine Website Default.asp ist, gibt eine Anforderung an http://example.com/ C:\Inetpub\Wwwroot und nicht C:\Inetpub\Wwwroot\Wwwroot\Default.asp zurück.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie die GetPhysicalPath Methode zum Erstellen eines HTTP-Moduls verwendet wird, das den physischen Pfad für die aktuelle Anforderung abruft und den Pfad zu einem Webclient zurückgibt.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnMapPath(
        IN IHttpContext * pHttpContext,
        IN IMapPathProvider * pProvider
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Set the initial return status flag to false.
        fReturnInformation = false;

        // Buffer to store the translated path.
        char* pszPhysicalPath;

        // Retrieve a pointer to the physical path.
        PCWSTR pwszPhysicalPath = pProvider->GetPhysicalPath();

        // Test for an error.
        if (NULL != pwszPhysicalPath)
        {
            // Length of the returned path.
            DWORD cbPhysicalPath = (DWORD) wcslen(pwszPhysicalPath);
            // Allocate space to store the path.
            pszPhysicalPath  =
                (PSTR) pHttpContext->AllocateRequestMemory(cbPhysicalPath + 1);
            // Test for an error.
            if (pszPhysicalPath==NULL)
            {
                // 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(pszPhysicalPath,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,
                "Physical path: ",pszPhysicalPath);

            // Set the flag that the module will return information.
            fReturnInformation = true;

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

    REQUEST_NOTIFICATION_STATUS
    OnPreExecuteRequestHandler(
        IN IHttpContext *                       pHttpContext,
        IN IHttpEventProvider *             pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );

        // Check the return status.
        if (fReturnInformation == true)
        {
            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

private:

    // Create boolean variable to track the return status.
    bool fReturnInformation;

    // 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_MAP_PATH | RQ_PRE_EXECUTE_REQUEST_HANDLER,
        0
    );
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen oder das Modul mithilfe der /EXPORT:RegisterModule Option kompilieren. Weitere Informationen finden Sie unter Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufenkonvention verwenden, anstatt die aufrufende Konvention für jede Funktion explizit zu deklarieren.

Anforderungen

Typ	BESCHREIBUNG
Kunde	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 unter Windows 10
Server	– IIS 7.0 unter Windows Server 2008 - IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 - IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter Windows Server 2016
Produkt	- 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
Kopfzeile	Httpserv.h

Siehe auch

IMapPathProvider-Schnittstelle