IHttpResponse::Redirect-Methode

Artikel
07/19/2023

Leitet den Client an eine angegebene URL um.

Syntax

virtual HRESULT Redirect(  
   IN PCSTR pszUrl,  
   IN BOOL fResetStatusCode = TRUE,  
   IN BOOL fIncludeParameters = FALSE  
) = 0;

Parameter

pszUrl
[IN] Ein Zeiger auf eine Zeichenfolge, die die URL für die Umleitung enthält.

fResetStatusCode
[IN] true , um den HTTP-status Code auf einen 302-status festzulegen, false um eine HTML-Nachricht zurückzugeben, die angibt, dass die Seite verschoben wurde.

fIncludeParameters
[IN] true , um die Abfragezeichenfolge aus der ursprünglichen HTTP-Anforderung an die umgeleitete URL zu übergeben; falseandernfalls .

Rückgabewert

HRESULT. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Wert	BESCHREIBUNG
S_OK	Gibt an, dass der Vorgang erfolgreich war.
ERROR_INVALID_PARAMETER	Gibt an, dass ein angegebener Parameter ungültig war.
ERROR_NOT_ENOUGH_MEMORY	Gibt an, dass nicht genügend Arbeitsspeicher zum Ausführen des Vorgangs vorhanden ist.

Bemerkungen

Wenn der fResetStatusCode Parameter ist true, leitet die Redirect -Methode einen Client automatisch an eine durch den pszUrl Parameter angegebene URL um. Wenn fResetStatusCode ist false, gibt die Redirect Methode eine HTML-Nachricht zurück, die angibt, dass die URL an den neuen Speicherort verschoben wurde. Wenn die durch den pszUrl Parameter angegebene URL ein relativer Pfad ist, wird die URL in eine absolute URL innerhalb der Anforderungsdomäne konvertiert.

Hinweis

Wenn Sie nach dem Aufrufen der Redirect -Methode keine RQ_NOTIFICATION_FINISH_REQUEST aus Ihrem Modul zurückgeben, löscht die Redirect Methode den Antwortpuffer nicht automatisch. In diesem Fall kann die nachfolgende Verarbeitung dem Antwortpuffer Informationen hinzufügen, und Sie erhalten möglicherweise unerwartete Ergebnisse, wenn Sie die Antwort nicht manuell löschen.

Hinweis

Die Redirect -Methode löscht die Antwortentität nicht auf den Client, und alle Daten in der Antwort werden entfernt, wenn Sie die Redirect -Methode aufrufen. Wenn die Antwort bereits an den Client geleert wurde, hat IIS die vorhandenen Header und Daten an den Client gesendet, und die Redirect Methode leitet den Client nicht an die neue URL um.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie Sie mit der Redirect -Methode ein HTTP-Modul erstellen, das einen Client an eine relative URL auf dem Webserver umleitet.

#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 response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Set the response header.
            HRESULT hr = pHttpResponse->Redirect("/example/",true,true);
            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
            }
            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

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

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

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

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

Anforderungen

type	BESCHREIBUNG
Client	– 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
Header	Httpserv.h

Weitere Informationen

IHttpResponse-Schnittstelle

Freigeben über