| title | IHttpResponse::DeleteHeader Method |
|---|---|
| description | Describes the IHttpResponse::DeleteHeader method and details its syntax, parameters, return value, remarks, example, and requirements. |
| ms.date | 10/07/2016 |
| ms.assetid | 39de98ea-52fa-2f0c-b077-646f1995042a |
Deletes a specified HTTP header.
virtual HRESULT DeleteHeader(
IN PCSTR pszHeaderName
) = 0;
virtual HRESULT DeleteHeader(
IN HTTP_HEADER_ID ulHeaderIndex
) = 0; pszHeaderName
[IN] A pointer to a string that contains the name of the header to delete.
ulHeaderIndex
[IN] The ID of an HTTP header to delete.
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. |
Note
The DeleteHeader method always returns a successful status, even if the specified header does not exist.
The DeleteHeader method deletes a specified HTTP header from the current response. 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.
Note
The HTTP_HEADER_ID enumeration is defined in the Http.h header file.
The following code example demonstrates how to use the DeleteHeader method to create an HTTP module that removes the Server and Location headers from the response.
[!code-cppIHttpResponseDeleteHeader#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.
| 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 |
IHttpResponse Interface
IHttpResponse::GetHeader Method
IHttpResponse::SetHeader Method