IHttpResponse::GetHeader メソッド
指定した HTTP ヘッダーの値を返します。
構文
virtual PCSTR GetHeader(
IN PCSTR pszHeaderName,
OUT USHORT* pcchHeaderValue = NULL
) const = 0;
virtual PCSTR GetHeader(
IN HTTP_HEADER_ID ulHeaderIndex,
OUT USHORT* pcchHeaderValue = NULL
) const = 0;
パラメーター
pszHeaderName
[IN]返すヘッダーの名前を含む文字列へのポインター。
ulHeaderIndex
[IN]返す HTTP ヘッダーの ID。
pcchHeaderValue
[OUT]ヘッダー値の長さを受け取る へのポインター USHORT
。
戻り値
指定したヘッダーを含む文字列へのポインター。
解説
メソッドは GetHeader
HTTP ヘッダーの値を返します。 メソッドには 2 つのオーバーロードされたバージョンがあります GetHeader
。 パラメーターに含まれる文字列を使用してヘッダーを pszHeaderName
指定します。 もう 1 つのオーバーロードでは、 パラメーターに含まれる符号なし long 整数を ulHeaderIndex
使用します。
パラメーターで pszHeaderName
指定されるヘッダー名は、カスタム ヘッダー、またはコメント要求 (RFC) 1945、"ハイパーテキスト転送プロトコル -- HTTP/1.0"、または RFC 2616、"ハイパーテキスト転送プロトコル -- HTTP/1.1" で定義されたヘッダーです。
Note
パラメーターを pszHeaderName
NULL に設定することはできません。
パラメーターは ulHeaderIndex
、列挙にリストされている HTTP ヘッダーの ID を HTTP_HEADER_ID
指定します。
Note
HTTP_HEADER_ID
列挙は Http.h ヘッダー ファイルで定義されます。
メソッドを GetHeader
呼び出すと、 pcchHeaderValue
パラメーターにはヘッダー値の長さが文字で格納されます。終端文字は含まれません。ヘッダーが見つからなかった場合は 0 になります。
例
次のコード例では、 メソッドをGetHeader
使用して、 ヘッダーと Location
ヘッダーの値を取得する HTTP モジュールを作成する方法をServer
示します。 その後、モジュールはこの情報を Web クライアントに送信します。
#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;
// Buffers to store the header values.
PCSTR pszServerHeader;
PCSTR pszLocationHeader;
// Lengths of the returned header values.
USHORT cchServerHeader;
USHORT cchLocationHeader;
// Retrieve a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Clear the existing response.
pHttpResponse->Clear();
// Set the MIME type to plain text.
pHttpResponse->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Retrieve the length of the "Server" header.
pszServerHeader = pHttpResponse->GetHeader("Server",&cchServerHeader);
if (cchServerHeader > 0)
{
// Allocate space to store the header.
pszServerHeader = (PCSTR) pHttpContext->AllocateRequestMemory( cchServerHeader + 1 );
// Test for an error.
if (pszServerHeader==NULL)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the "Server" header.
pszServerHeader = pHttpResponse->GetHeader(
"Server",&cchServerHeader);
// Return the "Server" header to the client.
WriteResponseMessage(pHttpContext,
"Server: ",pszServerHeader);
}
// Retrieve the length of the "Location" header.
pszLocationHeader = pHttpResponse->GetHeader(
HttpHeaderLocation,&cchLocationHeader);
if (cchLocationHeader > 0)
{
// Allocate space to store the header.
pszLocationHeader =
(PCSTR) pHttpContext->AllocateRequestMemory( cchLocationHeader + 1 );
// Test for an error.
if (pszServerHeader==NULL)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the "Location" header.
pszLocationHeader = pHttpResponse->GetHeader(
HttpHeaderLocation,&cchLocationHeader);
// Return the "Location" header to the client.
WriteResponseMessage(pHttpContext,
"Location: ",pszLocationHeader);
}
// 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)
明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。
要件
型 | 説明 |
---|---|
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 |
参照
IHttpResponse インターフェイス
IHttpResponse::SetHeader メソッド
IHttpResponse::D eleteHeader メソッド