IHttpContext::MapHandler メソッド
サイト上の指定した URL と HTTP 動詞のハンドラーをマップします。
構文
virtual HRESULT MapHandler(
DWORD dwSiteId,
PCWSTR pszSiteName,
PCWSTR pszUrl,
PCSTR pszVerb,
IScriptMapInfo ** ppScriptMap,
BOOL fIgnoreWildcardMappings
) = 0;
パラメーター
dwSiteId
[IN]マッピングの URL を含むサイトの ID。
pszSiteName
[IN]ターゲット URL のサイト名を含む文字列へのポインター。
pszUrl
[IN]マッピングの相対 URL を含む文字列へのポインター。
pszVerb
[IN]マッピング用の HTTP 動詞を含む文字列へのポインター。
ppScriptMap
[OUT]選択したスクリプト マップの詳細を含む IScriptMapInfo インターフェイスへのポインター。
fIgnoreWildcardMappings
[IN] true ワイルドカード マッピングを無視する場合は 。それ以外の場合は false。
戻り値
HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。
| 値 | 説明 |
|---|---|
| S_OK | 操作が成功したことを示します。 |
| ERROR_NOT_ENOUGH_MEMORY | 操作を実行するのに十分なメモリがないことを示します。 |
解説
インターフェイスは IScriptMapInfo 、 IHttpContext インターフェイスの有効期間に使用するために有効です。
例
次のコード例では、 メソッドを使用して、 を MapHandler 返す 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 request.
IHttpRequest * pHttpRequest = pHttpContext->GetRequest();
// Test for an error.
if (pHttpRequest != NULL)
{
// Length of the returned path.
DWORD cbPhysicalPath = 0;
// Get the length of the mapped path.
pHttpContext->MapPath(L"/",NULL,&cbPhysicalPath);
// Allocate space to store the path.
PWSTR pwszPhysicalPath =
(PWSTR) pHttpContext->AllocateRequestMemory(cbPhysicalPath+1);
PSTR pszPhysicalPath =
(PSTR) pHttpContext->AllocateRequestMemory(cbPhysicalPath+1);
// Test for an error.
if ((pwszPhysicalPath==NULL) || (pszPhysicalPath==NULL))
{
// Set the error status.
pHttpContext->GetResponse()->SetStatus(500,"Server Error",0,
HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY));
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the mapped path.
pHttpContext->MapPath(L"/",pwszPhysicalPath,&cbPhysicalPath);
// Convert the WCHAR string to a CHAR string.
wcstombs_s((size_t*)&cbPhysicalPath,pszPhysicalPath,
cbPhysicalPath,pwszPhysicalPath,cbPhysicalPath);
// Clear the existing response.
pHttpContext->GetResponse()->Clear();
// Set the MIME type to plain text.
pHttpContext->GetResponse()->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Return the path information.
WriteResponseMessage(pHttpContext,
"Path: ",pszPhysicalPath);
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Return processing to the pipeline.
return RQ_NOTIFICATION_CONTINUE;
}
private:
// Create a utility method that inserts a name/value pair into the response.
HRESULT WriteResponseMessage(
IHttpContext * pHttpContext,
PCSTR pszName,
PCSTR pszValue
)
{
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Create a data chunk.
HTTP_DATA_CHUNK dataChunk;
// Set the chunk to a chunk in memory.
dataChunk.DataChunkType = HttpDataChunkFromMemory;
// Buffer for bytes written of data chunk.
DWORD cbSent;
// Set the chunk to the first buffer.
dataChunk.FromMemory.pBuffer =
(PVOID) pszName;
// Set the chunk size to the first buffer size.
dataChunk.FromMemory.BufferLength =
(USHORT) strlen(pszName);
// Insert the data chunk into the response.
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,FALSE,TRUE,&cbSent);
// Test for an error.
if (FAILED(hr))
{
// Return the error status.
return hr;
}
// Set the chunk to the second buffer.
dataChunk.FromMemory.pBuffer =
(PVOID) pszValue;
// Set the chunk size to the second buffer size.
dataChunk.FromMemory.BufferLength =
(USHORT) strlen(pszValue);
// Insert the data chunk into the response.
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,FALSE,TRUE,&cbSent);
// Test for an error.
if (FAILED(hr))
{
// Return the error status.
return hr;
}
// Return a success status.
return S_OK;
}
};
// 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 |