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 헤더의 값을 반환합니다. 두 가지 오버로드된 버전의 메서드가 있습니다 GetHeader . 하나는 매개 변수에 포함된 문자열을 사용하여 헤더를 pszHeaderName 지정합니다. 다른 오버로드는 매개 변수에 포함된 ulHeaderIndex 부호 없는 긴 정수를 사용합니다.
매개 변수로 pszHeaderName 지정된 헤더 이름은 사용자 지정 헤더 또는 RFC(Request for Comments) 1945, "Hypertext Transfer Protocol -- HTTP/1.0" 또는 RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1"에 정의된 헤더일 수 있습니다.
참고
매개 변수를 pszHeaderName NULL로 설정할 수 없습니다.
매개 변수는 ulHeaderIndex 열거형에 나열된 HTTP 헤더의 ID를 HTTP_HEADER_ID 지정합니다.
참고
HTTP_HEADER_ID 열거형은 Http.h 헤더 파일에 정의되어 있습니다.
메서드 pcchHeaderValue 를 GetHeader 호출한 후 매개 변수는 종료 문자를 포함하지 않는 문자의 헤더 값 길이를 포함하거나 헤더를 찾을 수 없는 경우 0을 포함합니다.
예
다음 코드 예제를 사용 GetHeader 하는 방법에 설명 합니다 및 헤더의 값을 검색 하는 HTTP 모듈을 ServerLocation 만드는 방법입니다. 그런 다음, 모듈은 이 정보를 웹 클라이언트로 보냅니다.
#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) 코드를 컴파일할 수 있습니다.
요구 사항
| 형식 | Description |
|---|---|
| 클라이언트 | - 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 |
| 헤더 | Httpserv.h |
참고 항목
IHttpResponse 인터페이스
IHttpResponse::SetHeader 메서드
IHttpResponse::D eleteHeader 메서드