Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.98 KB

File metadata and controls

50 lines (37 loc) · 2.98 KB
title IHttpResponse::Clear Method
description IHttpResponse::Clear Method clears the response entity.
ms.date 10/07/2016
ms.assetid a85335e5-7fe8-d504-1a18-7ca0081c7317

IHttpResponse::Clear Method

Clears the response entity.

Syntax

virtual VOID Clear(  
   VOID  
) = 0;  

Parameters

This method takes no parameters.

Return Value

VOID.

Remarks

The Clear method empties the response contents, including the HTTP headers, the response body, and the HTTP status information. This method resets the response headers and body to default values.

Note

If the server has already flushed the response buffer to the client when you call the Clear method, the method may appear to have no effect.

Example

The following code example demonstrates how to use the Clear method to create an HTTP module that clears the response headers and body and returns a default response to the client.

[!code-cppIHttpResponseClear#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

IHttpResponse Interface
IHttpResponse::ClearHeaders Method