IHttpResponse::Metode Pengalihan

Mengalihkan klien ke URL tertentu.

Sintaks

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

Parameter

pszUrl
[IN] Penunjuk ke string yang berisi URL untuk pengalihan.

fResetStatusCode
[IN] true untuk mengatur kode status HTTP ke status 302; false untuk mengembalikan pesan HTML yang menunjukkan halaman telah dipindahkan.

fIncludeParameters
[IN] true untuk meneruskan string kueri dari permintaan HTTP asli ke URL yang dialihkan; jika tidak, false.

Tampilkan Nilai

Sebuah HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut.

Nilai	Deskripsi
S_OK	Menunjukkan bahwa operasi berhasil.
ERROR_INVALID_PARAMETER	Menunjukkan bahwa parameter yang ditentukan tidak valid.
ERROR_NOT_ENOUGH_MEMORY	Menunjukkan bahwa memori tidak cukup untuk melakukan operasi.

Keterangan

fResetStatusCode Ketika parameter adalah true, Redirect metode secara otomatis mengalihkan klien ke URL yang ditentukan oleh pszUrl parameter . Ketika fResetStatusCode adalah false, Redirect metode mengembalikan pesan HTML yang menyatakan bahwa URL telah dipindahkan ke lokasi baru. Jika URL yang ditentukan oleh pszUrl parameter adalah jalur relatif, URL akan dikonversi ke URL absolut dalam domain permintaan.

Catatan

Jika Anda tidak mengembalikan RQ_NOTIFICATION_FINISH_REQUEST dari modul setelah memanggil Redirect metode , Redirect metode tidak akan secara otomatis menghapus buffer respons. Dalam situasi ini, pemrosesan berikutnya dapat menambahkan informasi ke buffer respons, dan Anda mungkin menerima hasil yang tidak terduga jika Anda tidak menghapus respons secara manual.

Catatan

Metode Redirect ini tidak menghapus entitas respons ke klien, dan data apa pun dalam respons akan dihapus saat Anda memanggil Redirect metode . Jika respons telah dihapus ke klien, IIS akan mengirim header dan data yang ada ke klien, dan Redirect metode tidak akan mengalihkan klien ke URL baru.

Contoh

Contoh kode berikut menunjukkan cara menggunakan Redirect metode untuk membuat modul HTTP yang mengalihkan klien ke URL relatif di server Web.

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

Modul Anda harus mengekspor fungsi RegisterModule . Anda dapat mengekspor fungsi ini dengan membuat file definisi modul (.def) untuk proyek Anda, atau Anda dapat mengkompilasi modul dengan menggunakan sakelar /EXPORT:RegisterModule . Untuk informasi selengkapnya, lihat Panduan: Membuat Modul HTTP Request-Level Dengan Menggunakan Kode Asli.

Anda dapat secara opsional mengkompilasi kode dengan menggunakan __stdcall (/Gz) konvensi panggilan alih-alih secara eksplisit mendeklarasikan konvensi panggilan untuk setiap fungsi.

Persyaratan

Jenis	Deskripsi
Klien	- IIS 7.0 di Windows Vista - IIS 7.5 di Windows 7 - IIS 8.0 di Windows 8 - IIS 10.0 pada Windows 10
Server	- IIS 7.0 di Windows Server 2008 - IIS 7.5 di Windows Server 2008 R2 - IIS 8.0 di Windows Server 2012 - IIS 8.5 di Windows Server 2012 R2 - IIS 10.0 di Windows Server 2016
Produk	- 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

Lihat juga

Antarmuka IHttpResponse