IHttpResponse::D eleteHeader (Método)
Elimina un encabezado HTTP especificado.
Sintaxis
virtual HRESULT DeleteHeader(
IN PCSTR pszHeaderName
) = 0;
virtual HRESULT DeleteHeader(
IN HTTP_HEADER_ID ulHeaderIndex
) = 0;
Parámetros
pszHeaderName
[IN] Puntero a una cadena que contiene el nombre del encabezado que se va a eliminar.
ulHeaderIndex
[IN] Identificador de un encabezado HTTP que se va a eliminar.
Valor devuelto
Una clase HRESULT
. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.
Valor | Descripción |
---|---|
S_OK | Indica que la operación se realizó correctamente. |
Nota
El DeleteHeader
método siempre devuelve un estado correcto, incluso si el encabezado especificado no existe.
Comentarios
El DeleteHeader
método elimina un encabezado HTTP especificado de la respuesta actual. Hay dos versiones sobrecargadas del DeleteHeader
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 .
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 el DeleteHeader
método para crear un módulo HTTP que quite los Server
encabezados y Location
de la respuesta.
#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 a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Delete the "Server" header.
hr = pHttpResponse->DeleteHeader("Server");
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Delete the "Location" header.
hr = pHttpResponse->DeleteHeader(HttpHeaderLocation);
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
}
// Return processing to the pipeline.
return RQ_NOTIFICATION_CONTINUE;
}
};
// 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 |
---|---|
Remoto | - IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10 |
Servidor | - 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
IHttpResponse (interfaz)
IHttpResponse::GetHeader (Método)
IHttpResponse::SetHeader (Método)