IHttpRequest::SetUrl メソッド
要求 URL を変更します。
構文
virtual HRESULT SetUrl(
IN PCWSTR pszUrl,
IN DWORD cchUrl,
IN BOOL fResetQueryString
) = 0;
virtual HRESULT SetUrl(
IN PCSTR pszUrl,
IN DWORD cchUrl,
IN BOOL fResetQueryString
) = 0;
パラメーター
pszUrl
[IN]設定する URL を含む文字列へのポインター。
cchUrl
[IN]で指定された URL の長さ (文字数)。pszUrl
fResetQueryString
[IN] true 既存のクエリ文字列をリセットする場合は 。それ以外の場合は false。
戻り値
HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。
| 値 | 説明 |
|---|---|
| S_OK | 操作が成功したことを示します。 |
| ERROR_INVALID_PARAMETER | 指定したパラメーターが無効であることを示します (たとえば、指定した URL が長すぎます)。 |
| ERROR_NOT_ENOUGH_MEMORY | 操作を実行するのに十分なメモリがないことを示します。 |
解説
メソッドは SetUrl 、現在の要求の URL を変更します。 メソッドには 2 つのオーバーロードされたバージョンがあります SetUrl 。 1 つを使用すると、文字列へのポインターを使用してヘッダーを指定できます。 もう 1 つのオーバーロードでは、ワイド文字列へのポインターが使用されます。
後続の要求処理関数とログ記録操作では、クライアントが URL を要求したかのように新しい URL が処理されます。 したがって、URL の変更によって発生したエラー条件は、クライアントに返されます。 たとえば、新しい URL が存在しない場合、Web サーバーは HTTP 404 エラーを返します。
警告
メソッドは SetUrl 、要求の初期パラメーターが収集された後に呼び出されるため、後続の要求処理で変更された URL が認識されないことがあります。 たとえば、URL サーバー変数を取得すると、変更された URL ではなく、元の要求が反映されます。 実装者は、完全なパイプラインを介して要求を実行するために、代わりに SetUrlIHttpContext::ExecuteRequest メソッドを呼び出す必要があります。 URL の SetUrl 書き換えには、 メソッドを使用しないでください。
Note
IHttpResponse::Redirect メソッドとは異なり、 SetUrl メソッドはクライアントを新しい URL にリダイレクトしません。
Note
HTTP 統合要求処理パイプラインの最初のイベントの前に メソッドを呼び出す SetUrl 必要があります。 SetUrl OnPostBeginRequest ハンドラーから メソッドを呼び出すと、不確定な動作になります。
例
次のコード例では、 メソッドを使用 SetUrl して、要求された URL を別の URL に変更する方法を示します。
#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
)
{
HRESULT hr;
// Retrieve a pointer to the request.
IHttpRequest * pHttpRequest = pHttpContext->GetRequest();
// Test for an error.
if (pHttpRequest != NULL)
{
// Create a buffer with an example URL.
PCSTR pszBuffer = "/example/default.aspx";
// Set the URL for the request.
hr = pHttpRequest->SetUrl(
pszBuffer,(DWORD)strlen(pszBuffer),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
);
}
要件
| 型 | 説明 |
|---|---|
| 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 |
| Product | - 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 |
| ヘッダー | Httpserv.h |