IHttpRequest::GetHeader (Método)
Devuelve el valor de un encabezado HTTP especificado.
Sintaxis
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;
Parámetros
pszHeaderName
[IN] Puntero a una cadena que contiene el nombre del encabezado que se va a devolver.
ulHeaderIndex
[IN] Identificador del encabezado HTTP que se va a devolver.
pcchHeaderValue
[OUT] Puntero a un entero largo sin signo que recibe la longitud del valor de encabezado devuelto.
Valor devuelto
Puntero a una cadena que contiene el encabezado especificado o 0 si no se encontró el encabezado.
Observaciones
El GetHeader método devuelve el valor de un encabezado HTTP para la solicitud actual. Hay dos versiones sobrecargadas del GetHeader método . Uno especifica el encabezado mediante una cadena contenida en el pszHeaderName parámetro . La otra sobrecarga usa un entero largo sin signo contenido en el ulHeaderIndex parámetro . Después de llamar al GetHeader método , el pcchHeaderValue parámetro contendrá la longitud, en caracteres, del valor de encabezado, sin incluir el carácter de terminación. pcchHeaderValue será 0 si no se encuentra el encabezado.
El nombre de encabezado especificado por el pszHeaderName parámetro puede ser un encabezado personalizado o un encabezado definido en Solicitud de comentarios (RFC) 1945, "Protocolo de transferencia de hipertexto -- HTTP/1.0" o RFC 2616, "Protocolo de transferencia de hipertexto -- HTTP/1.1.
Nota:
El pszHeaderName parámetro no se puede establecer en null.
El ulHeaderIndex parámetro especifica el identificador de un encabezado HTTP que aparece en la HTTP_HEADER_ID enumeración.
Nota:
La HTTP_HEADER_ID enumeración se define en el archivo de encabezado Http.h.
Ejemplo
En el ejemplo de código siguiente se muestra cómo usar ambas versiones del GetHeader método para crear un módulo HTTP que recupere los User-Agent encabezados HTTP y Accept-Language para la solicitud.
#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;
// Create buffers to store the returned header values.
PCSTR pszUserAgent;
PCSTR pszAcceptLanguage;
// Create buffers to store lengths of the returned header values.
USHORT cchUserAgent;
USHORT cchAcceptLanguage;
// Retrieve a pointer to the request.
IHttpRequest * pHttpRequest = pHttpContext->GetRequest();
// Test for an error.
if (pHttpRequest != NULL)
{
// 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);
// Look for the "User-Agent" header.
pszUserAgent = pHttpRequest->GetHeader("User-Agent",&cchUserAgent);
// The header length will be 0 if the header was not found.
if (cchUserAgent == 0)
{
// Return a status message.
WriteResponseMessage(pHttpContext,
"User-Agent: ","(none)");
}
else
{
// Allocate space to store the header.
pszUserAgent = (PCSTR) pHttpContext->AllocateRequestMemory( cchUserAgent + 1 );
// Test for an error.
if (pszUserAgent==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 "User-Agent" header.
pszUserAgent = pHttpRequest->GetHeader("User-Agent",&cchUserAgent);
// Test for an error.
if (pszUserAgent!=NULL)
{
// Return the header information.
WriteResponseMessage(pHttpContext,
"User-Agent: ",pszUserAgent);
}
}
// Look for the "Accept-Language" header.
pszAcceptLanguage = pHttpRequest->GetHeader(HttpHeaderAcceptLanguage,&cchAcceptLanguage);
// The header length will be 0 if the header was not found.
if (cchAcceptLanguage == 0)
{
// Return a status message.
WriteResponseMessage(pHttpContext,
"\nAccept-Language: ","(none)");
}
else
{
// Allocate space to store the header.
pszAcceptLanguage = (PCSTR) pHttpContext->AllocateRequestMemory( cchAcceptLanguage + 1 );
// Test for an error.
if (pszAcceptLanguage==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 "Accept-Language" header.
pszAcceptLanguage = pHttpRequest->GetHeader(HttpHeaderAcceptLanguage,&cchAcceptLanguage);
// Test for an error.
if (pszAcceptLanguage!=NULL)
{
// Return the header information.
WriteResponseMessage(pHttpContext,
"\nAccept-Language: ",pszAcceptLanguage);
}
}
// 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
);
}
El módulo debe exportar la función RegisterModule . Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.
Opcionalmente, puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.
Requisitos
| Tipo | Descripción |
|---|---|
| Cliente | - IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10 |
| Server | - IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016 |
| Producto | - 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 |
| Encabezado | Httpserv.h |
Consulte también
IHttpRequest (interfaz)
IHttpRequest::D eleteHeader (Método)
IHttpRequest::SetHeader (Método)