IHttpContext::GetRootContext Method

IIS 7.0
 

Retrieves a pointer to the root context for the current context.

virtual IHttpContext* GetRootContext(
   VOID
) const = 0;

This method takes no parameters.

A pointer to an IHttpContext interface.

The GetRootContext method retrieves a pointer to the IHttpContext interface for the root context of the current request. For example, if an HTTP module creates a child context by using the CloneContext method, the GetRootContext method can help determine whether the module is processing on the root context or on the child context.

System_CAPS_noteNote

When the current context is the root context, the GetRootContext method will return NULL.

Example

The following code example demonstrates how to use the GetRootContext method to create an HTTP module that retrieves the root context for the request. The module compares the root context with NULL and the current request context to determine whether the root context is different than the current context. The module then returns a message to the Web client and exits.

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 Windows Vista

  • IIS 7.5 on Windows 7

  • IIS 8.0 on Windows 8

  • IIS 10.0 on Windows 10

Server

  • IIS 7.0 on Windows Server 2008

  • 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 Technical Preview

Product

  • IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0

  • IIS Express 7.5, IIS Express 8.0, IIS Express 10.0

Product

IIS 7.0, IIS 7.5, IIS Express 7.5, IIS 8.0

Header

Httpserv.h

Show: