Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 4.21 KB

ihttprequest-deleteheader-method.md

File metadata and controls

70 lines (51 loc) · 4.21 KB
title ms.date description ms.assetid
IHttpRequest::DeleteHeader Method
10/07/2016
Learn how to Delete an HTTP header from the request using two overloaded versions of the DeleteHeader method.
922cd9ec-3c4d-81f8-581e-e7d81683c716

IHttpRequest::DeleteHeader Method

Deletes an HTTP header from the request.

Syntax

virtual HRESULT DeleteHeader(  
   IN PCSTR pszHeaderName  
) = 0;  
  
virtual HRESULT DeleteHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex  
) = 0;

Parameters

pszHeaderName
[IN] A pointer to a string that contains the name of the header to delete.

ulHeaderIndex
[IN] An HTTP_HEADER_ID value that specifies the ID of an HTTP header to delete.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK Indicates that the operation was successful.

Remarks

The DeleteHeader method deletes a specified HTTP header from the current request. There are two overloaded versions of the DeleteHeader method. One specifies the header by using a string that is contained in the pszHeaderName parameter. The other overload uses an unsigned long integer that is contained in the ulHeaderIndex parameter.

The header name specified by the pszHeaderName parameter can be a custom header or a header defined in Request for Comments (RFC) 1945, "Hypertext Transfer Protocol -- HTTP/1.0," or RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1."

Note

The pszHeaderName parameter cannot be set to null.

The ulHeaderIndex parameter specifies the ID of an HTTP header that is listed in the HTTP_HEADER_ID enumeration, which contains several common HTTP headers.

Note

The HTTP_HEADER_ID enumeration is defined in the Http.h header file.

Example

The following code example illustrates how to use both versions of the DeleteHeader method to create an HTTP module that removes the User-Agent and Accept-Language HTTP headers from the request.

[!code-cppIHttpRequestDeleteHeader#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpRequest Interface
IHttpRequest::GetHeader Method
IHttpRequest::SetHeader Method