Skip to content

ihttpcontext-getconnection-method.md

Latest commit

 

History

History
49 lines (36 loc) · 3.71 KB

ihttpcontext-getconnection-method.md

File metadata and controls

49 lines (36 loc) · 3.71 KB
title IHttpContext::GetConnection Method
description Learn how the GetConnection method retrieves the connection container for the current context.
ms.date 10/07/2016
ms.assetid d6bf938c-60e8-5d4b-408b-916efcad9f6c

IHttpContext::GetConnection Method

Retrieves the connection container for the current context.

Syntax

virtual IHttpConnection* GetConnection(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to an IHttpConnection interface.

Remarks

The GetConnection method retrieves a pointer to an IHttpConnection interface that can be used to retrieve information about the current connection. For example, the IHttpConnection::IsConnected method returns a Boolean value that indicates whether a Web client is still connected to the current request.

Note

IHttpContext owns the lifetime of this object. Therefore, you do not free this pointer when you write your application.

Example

The following code example demonstrates how to use the GetConnection method to create an HTTP module that retrieves a pointer to an IHttpConnection interface. The example then calls the IHttpConnection::IsConnected method to determine whether the Web client that initiated the current request is still connected. If the client is still connected, the HTTP module will return a status message to the Web client. If the client is not connected, the module will return RQ_NOTIFICATION_FINISH_REQUEST to end additional processing.

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

IHttpContext Interface