IHttpContext::ExecuteRequest メソッド
子要求を実行します。
構文
virtual HRESULT ExecuteRequest(
IN BOOL fAsync,
IN IHttpContext* pHttpContext,
IN DWORD dwExecuteFlags,
IN IHttpUser* pHttpUser,
OUT BOOL* pfCompletionExpected = NULL
) = 0;
パラメーター
fAsync
[IN]Always true
(非同期実行を指定します)。
pHttpContext
[IN]実行する子 IHttpContext へのポインター。
dwExecuteFlags
[IN] DWORD
要求実行フラグを格納している 。
pHttpUser
[IN]要求の IHttpUser へのポインター。 (省略可能)
pfCompletionExpected
[OUT] true
非同期完了がまだ保留中の場合は 。それ以外の場合は false
。 (省略可能)
戻り値
HRESULT
。 有効な値を次の表に示しますが、これ以外にもあります。
値 | 説明 |
---|---|
S_OK | 操作が成功したことを示します。 |
ERROR_NOT_SUPPORTED | 要求がサポートされていないことを示します (たとえば、 が にfalse 設定されているか、fAsync 子要求が親要求から複製されていません)。 |
ERROR_STACK_OVERFLOW | 要求が再帰的な子要求の制限を超えていることを示します。 |
解説
メソッドは ExecuteRequest
、 パラメーターの IHttpContext インターフェイスで指定された子要求を pHttpContext
実行します。 この要求コンテキストは、 IHttpContext::CloneContext メソッドを使用して作成する必要があります。
重要
親要求によって複製されていない子要求を実行しようとすると、ERROR_NOT_SUPPORTEDが返されます。
各子コンテキストは 1 回だけ実行できますが、子要求は再帰的に入れ子にすることができます。
注意
再帰的な子要求の制限は 10 です。
メソッドは ExecuteRequest
非同期操作のみをサポートしているため、スレッド プールの枯渇を防ぎます。
重要
同期子要求を実行しようとすると、ERROR_NOT_SUPPORTEDが返されます。
で実行フラグ dwExecuteFlags
を指定することで、子要求の実行動作を制御できます。 次の表に、これらのフラグに使用できる値を示します。
値 | 説明 |
---|---|
EXECUTE_FLAG_NO_HEADERS | 子要求の HTTP ヘッダーを抑制します。 |
EXECUTE_FLAG_IGNORE_CURRENT_INTERCEPTOR | この要求チェーンの現在のスクリプト マップ ハンドラーを無視します。 |
EXECUTE_FLAG_IGNORE_APPPOOL | 子要求が同じアプリケーション プールにない場合でも、要求を実行します。 |
EXECUTE_FLAG_DISABLE_CUSTOM_ERROR | 子要求のカスタム エラーを無効にします。 |
EXECUTE_FLAG_SAME_URL | 子要求の URL は、親要求と同じです。 メモ: スクリプト マップ ハンドラーは、このフラグを使用して実行を転送します。 |
EXECUTE_FLAG_BUFFER_RESPONSE | 子応答をフラッシュしないでください。は、親要求への応答を返します。 |
EXECUTE_FLAG_HTTP_CACHE_ELIGIBLE | 子応答は引き続き、Http.sysによるキャッシュの対象となります。 メモ: 子要求が実行されると、キャッシュは既定で無効になります。 |
に インターフェイスpHttpUser
をIHttpUser
指定した場合、子要求の認証はスキップされます。
例
次のコード例では、次のタスクを実行する HTTP モジュールを作成する方法を示します。
モジュールは 、RQ_MAP_PATH 通知に登録します。
このモジュールでは、OnMapPath メソッドと OnAsyncCompletion メソッドを含む CHttpModule クラスを作成します。
Web クライアントが URL を要求すると、IIS はモジュールの
OnMapPath
メソッドを呼び出します。 このメソッドは、次のタスクを実行します。現在の要求の URL が Web サイトのルートにある 2 つの特定の URL と一致するかどうかをテストします。 URL が指定された URL のいずれかに一致する場合、モジュールは メソッドを
IHttpContext::CloneContext
使用して現在の要求の複製を作成します。クローンの
IHttpRequest::SetUrl
メソッドを呼び出して、クローンの URL を /example/default.aspx に設定します。メソッドを
ExecuteRequest
呼び出して子要求を実行します。非同期完了をテストします。 非同期完了が保留中の場合、モジュールは統合された要求処理パイプラインに処理を返します。 そうでない場合、モジュールは複製されたコンテキストを解放します。
非同期入力候補が必要な場合、IIS はモジュールの
OnAsyncCompletion
メソッドを呼び出します。 このメソッドは、複製されたコンテキストを解放します。モジュールは、 クラスを
CHttpModule
メモリから削除してから終了します。
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create the module class.
class MyHttpModule : public CHttpModule
{
private:
// Create a pointer for a child request.
IHttpContext * m_pChildRequestContext;
public:
MyHttpModule(void)
{
m_pChildRequestContext = NULL;
}
REQUEST_NOTIFICATION_STATUS
OnMapPath(
IN IHttpContext * pHttpContext,
IN IMapPathProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
HRESULT hr;
BOOL fCompletionExpected;
// Retrieve a pointer to the URL.
PCWSTR pwszUrl = pProvider->GetUrl();
// Only process requests for the root.
if (0 == wcscmp(pwszUrl,L"/") || 0 == wcscmp(pwszUrl,L"/default.aspx"))
{
// Clone the current context.
hr = pHttpContext->CloneContext(
CLONE_FLAG_BASICS, &m_pChildRequestContext );
// Test for a failure.
if (FAILED(hr))
{
goto Failure;
}
// Test for an error.
if ( NULL != m_pChildRequestContext )
{
// Set the URL for the child request.
hr = m_pChildRequestContext->GetRequest()->SetUrl(
"/example/default.aspx",
(DWORD)strlen("/example/default.aspx"),false);
// Test for a failure.
if (FAILED(hr))
{
goto Failure;
}
// Execute the child request.
hr = pHttpContext->ExecuteRequest(
TRUE, m_pChildRequestContext,
0, NULL, &fCompletionExpected );
// Test for a failure.
if (FAILED(hr))
{
goto Failure;
}
// Test for pending asynchronous operations.
if (fCompletionExpected)
{
return RQ_NOTIFICATION_PENDING;
}
}
Failure:
// Test for a child request.
if (NULL != m_pChildRequestContext)
{
// Release the child request.
m_pChildRequestContext->ReleaseClonedContext();
m_pChildRequestContext = NULL;
}
}
// Return processing to the pipeline.
return RQ_NOTIFICATION_CONTINUE;
}
REQUEST_NOTIFICATION_STATUS
OnAsyncCompletion(
IN IHttpContext * pHttpContext,
IN DWORD dwNotification,
IN BOOL fPostNotification,
IN IHttpEventProvider * pProvider,
IN IHttpCompletionInfo * pCompletionInfo
)
{
// Test for a child request.
if (NULL != m_pChildRequestContext)
{
// Release the child request.
m_pChildRequestContext->ReleaseClonedContext();
m_pChildRequestContext = NULL;
}
// 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 we 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 );
return pModuleInfo->SetRequestNotifications(
new MyHttpModuleFactory,
RQ_MAP_PATH,
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 |
参照
IHttpContext インターフェイス
IHttpContext::CloneContext メソッド
IHttpContext::GetParentContext メソッド
IHttpContext::ReleaseClonedContext メソッド