IHttpContext::GetTraceContext メソッド
現在のコンテキストのトレース コンテキスト コンテナーを取得します。
構文
virtual IHttpTraceContext* GetTraceContext(
VOID
) const = 0;
パラメーター
このメソッドは、パラメーターを受け取りません。
戻り値
IHttpTraceContext インターフェイスへのポインター。
解説
HTTP 要求に関連付けられているイベントを IHttpContext::GetTraceContext 発生させる必要がある場合は、 または IHttpServer::GetTraceContext メソッドを使用してインターフェイスを取得 IHttpTraceContext します。 HTTP 要求に関連付けられていないイベントを発生させる必要がある場合は、 メソッドのみを IHttpServer::GetTraceContext 使用してインターフェイスを IHttpTraceContext 取得します。
例
次のコード例では、次のタスクを実行する HTTP モジュールを作成する方法を示します。
メソッドを使用してインターフェイス
IHttpTraceContextへのポインターをIHttpContext::GetTraceContext取得します。IHttpTraceContext::GetTraceActivityId メソッドを使用してトレース アクティビティ GUID を取得します。
トレース アクティビティ GUID を含む文字列を作成し、その文字列をイベント ビューアーに書き込みます。
#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 );
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Retrieve the trace context.
IHttpTraceContext * pTraceContext = pHttpContext->GetTraceContext();
// Test for errors.
if (NULL != pTraceContext)
{
// Retrieve the trace activity GUID.
LPCGUID pTraceGuid = pTraceContext->GetTraceActivityId();
// Test for errors.
if (NULL != pTraceGuid)
{
// Create a string buffer for the converted Unicode GUID.
WCHAR pwszGuid[256] = L"";
// Convert the GUID to a Unicode string.
int cbBytes = StringFromGUID2(*pTraceGuid, pwszGuid, 256);
// Allocate space for an ANSI string.
PSTR pszGuid = (PSTR) pHttpContext->AllocateRequestMemory(
(DWORD)cbBytes);
// Convert the Unicode string to an ANSI string.
wcstombs_s((size_t*)&cbBytes,pszGuid,cbBytes,pwszGuid,cbBytes);
// Test for errors.
if (cbBytes > 0)
{
// 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 GUID to the Web client.
WriteResponseMessage(pHttpContext,"Trace Activity ID: ",pszGuid);
// 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. (Defined in the Http.h file.)
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 |
参照
IHttpContext インターフェイス
IHttpServer::GetTraceContext メソッド
IHttpTraceContext インターフェイス