IHttpResponse::Redirect メソッド
指定した URL にクライアントをリダイレクトします。
構文
virtual HRESULT Redirect(
IN PCSTR pszUrl,
IN BOOL fResetStatusCode = TRUE,
IN BOOL fIncludeParameters = FALSE
) = 0;
パラメーター
pszUrl
[IN]リダイレクト用の URL を含む文字列へのポインター。
fResetStatusCode
[IN] true HTTP 状態コードを 302 状態に設定する場合は 。 false ページが移動されたことを示す HTML メッセージを返します。
fIncludeParameters
[IN] true 元の HTTP 要求からリダイレクトされた URL にクエリ文字列を渡す場合は 。それ以外の場合は false。
戻り値
HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。
| 値 | 説明 |
|---|---|
| S_OK | 操作が成功したことを示します。 |
| ERROR_INVALID_PARAMETER | 指定したパラメーターが無効であることを示します。 |
| ERROR_NOT_ENOUGH_MEMORY | 操作を実行するのに十分なメモリがないことを示します。 |
解説
パラメーターが のfResetStatusCode場合、 メソッドはtrueRedirect、 パラメーターで指定された URL にクライアントを自動的にpszUrlリダイレクトします。 が のfalse場合fResetStatusCode、 メソッドはRedirect、URL が新しい場所に移動したことを示す HTML メッセージを返します。 パラメーターで pszUrl 指定された URL が相対パスの場合、URL は要求ドメイン内の絶対 URL に変換されます。
注意
メソッドを呼び出した後にモジュールから RQ_NOTIFICATION_FINISH_REQUEST を Redirect 返さない場合、 Redirect メソッドは応答バッファーを自動的にクリアしません。 このような状況では、後続の処理によって応答バッファーに情報が追加され、応答を手動でクリアしないと予期しない結果が発生する可能性があります。
注意
メソッドは Redirect 応答エンティティをクライアントにフラッシュせず、メソッドを呼び出すと応答内のすべてのデータが Redirect 削除されます。 応答が既にクライアントにフラッシュされている場合、IIS は既存のヘッダーとデータをクライアントに送信し Redirect 、メソッドはクライアントを新しい URL にリダイレクトしません。
例
次のコード例では、 メソッドを Redirect 使用して、クライアントを Web サーバー上の相対 URL にリダイレクトする HTTP モジュールを作成する方法を示します。
#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
);
}
モジュールは RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したRequest-Level HTTP モジュールの作成」を参照してください。
必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。
要件
| Type | 説明 |
|---|---|
| Client | - Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 の IIS 8.0 - Windows 10の IIS 10.0 |
| サーバー | - Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 上の IIS 7.5 - Windows Server 2012 上の IIS 8.0 - Windows Server 2012 R2 上の IIS 8.5 - Windows Server 2016上の IIS 10.0 |
| 製品 | - 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 |