IMetadataInfo::GetMetaPath メソッド
現在のコンテキストの構成パスを取得します。
構文
virtual PCWSTR GetMetaPath(
VOID
) const = 0;
パラメーター
このメソッドは、パラメーターを受け取りません。
戻り値
構成パスを含む文字列へのポインター。
解説
メソッドは GetMetaPath
、現在のコンテキストの構成パスを取得します。 たとえば、IIS 7 を実行しているサーバー上の既定の Web サイトに対する要求は、通常、MACHINE/WEBROOT/APPHOST/Default Web Site パスを返します。
例
次のコード例では、 IHttpContext::GetMetadata メソッドを使用して IMetadataInfo インターフェイスへのポインターを取得する HTTP モジュールを作成する方法を示します。 このモジュールでは、次の手順を完了します。
メソッドを
GetMetaPath
使用して、現在の要求の構成パスを取得します。IHttpServer::GetConfigObject メソッドを使用して、INativeConfigurationSystem インターフェイスへのポインターを取得します。
現在の要求の構成パスを INativeConfigurationSystem::GetConfigSection メソッドに渡します。
IIS のログ設定の INativeConfigurationElement インターフェイスを取得します。
INativeConfigurationElement::GetBooleanProperty メソッドを使用して、現在の要求コンテキストでログ記録が有効かどうかを示す値を取得します。
この情報を Web クライアントに返し、終了します。
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnBeginRequest(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Create a boolean variable for the configuration setting.
BOOL fDoNotLog = FALSE;
// Create pointers to configuration objects.
INativeConfigurationSystem * pConfigSystem = NULL;
INativeConfigurationElement * pConfigElement = NULL;
// Retrieve a pointer to the IMetadataInfo interface.
IMetadataInfo * pMetadataInfo = pHttpContext->GetMetadata();
// Retrieve the configuration path.
PCWSTR pwszConfigPath = pMetadataInfo->GetMetaPath();
// Retrieve the configuration object.
pConfigSystem = g_pHttpServer->GetConfigObject();
// Test for an error.
if (NULL != pConfigSystem)
{
// Retrieve the HTTP logging configuration section.
hr = pConfigSystem->GetConfigSection(
L"system.webServer/httpLogging",
pwszConfigPath,&pConfigElement,NULL,NULL);
// Test for an error.
if (SUCCEEDED(hr))
{
// Retrieve the log settings from the configuration section.
hr = pConfigElement->GetBooleanProperty(
L"dontLog",&fDoNotLog,NULL);
// Test for an error.
if (SUCCEEDED(hr))
{
// 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);
// Allocate space for the configuration path.
PSTR pszConfigPath =
(PSTR) pHttpContext->AllocateRequestMemory(
(DWORD) wcslen(pwszConfigPath) + 1 );
// Test for an error.
if (NULL == pszConfigPath)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Convert the WCHAR string to a CHAR string.
wcstombs(pszConfigPath,
pwszConfigPath,wcslen(pwszConfigPath));
// Return the configuration path.
WriteResponseMessage(pHttpContext,
"\nConfiguration path:\t",pszConfigPath);
// Return the configuration setting.
WriteResponseMessage(pHttpContext,"\nLogging enabled:\t",
(FALSE == fDoNotLog) ? "Yes" : "No");
// 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 );
// Store the pointer for the global server interface.
g_pHttpServer = 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 |