Skip to content

ihttpcontext-getsite-method.md

Latest commit

 

History

History
49 lines (36 loc) · 3.47 KB

ihttpcontext-getsite-method.md

File metadata and controls

49 lines (36 loc) · 3.47 KB
title IHttpContext::GetSite Method
description Describes the IHttpContext::GetSite method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 6f8d5532-f308-dca2-7d5a-ca62b959f801

IHttpContext::GetSite Method

Retrieves the site information container for the current context.

Syntax

virtual IHttpSite* GetSite(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to an IHttpSite interface.

Remarks

The GetSite method retrieves a pointer to an IHttpSite interface, which can retrieve additional information about the Web site that is processing the request, for the current context. For example, you could create an HTTP module that uses the IHttpSite::GetSiteId method to retrieve the site ID.

Note

The HTTP context object owns the lifetime of this object. Therefore, you do not free this pointer when you write HTTP modules.

Example

The following code example demonstrates how to use the GetSite method to create an HTTP module that retrieves an IHttpSite interface. The module uses the IHttpSite::GetSiteName method to retrieve the name of the Web site for the current request, and then it returns the name of the Web site to a Web client.

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