Skip to content

iurikey-interface.md

Latest commit

 

History

History
80 lines (62 loc) · 5.93 KB

iurikey-interface.md

File metadata and controls

80 lines (62 loc) · 5.93 KB
title IUriKey Interface
description Describes the IUriKey interface and details its syntax, methods, derived classes, remarks, code example, inheritance hierarchy, and requirements.
ms.date 10/07/2016
ms.assetid a922afbd-c069-af8f-3ac8-413c70eb1489

IUriKey Interface

Represents key information for accessing associated data in the Uniform Resource Identifier (URI) cache.

Syntax

class IUriKey : public IHttpCacheKey

Methods

The following table lists the methods exposed by the IUriKey interface.

Name Description
Enum (Inherited from IHttpCacheKey.)
GetCacheName Overridden. Returns the name of the URI cache.
GetConfigPath Returns the path of the configuration file.
GetHash (Inherited from IHttpCacheKey.)
GetIsEqual (Inherited from IHttpCacheKey.)
GetIsPrefix (Inherited from IHttpCacheKey.)
GetSiteId Returns the site identifier associated with URI data.
GetSiteName Returns the site name associated with the URI data.
GetUrl Returns the URL associated with the URI data.
UpdateFrequentlyHitTickCount Increments a counter each time the URI is requested.

Derived Classes

This interface contains no derived classes.

Remarks

The IUriKey interface extends the IHttpCacheKey interface by adding support for returning a site identifier, a site name, and the URL of the data in the cache. IUriKey also overrides the IHttpCacheKey::GetCacheName method by providing the default implementation through the IUriKey::GetCacheName method.

Example

The following code example demonstrates how to create a global module that listens for GL_CACHE_OPERATION and GL_CACHE_CLEANUP events and then writes the IUriKey information to the Event Viewer.

Caution

[!INCLUDEiisver] generates a large number of events in the Event Viewer. To avoid a log overflow error in a production environment, you should generally avoid writing cache information to the event log. For demonstration purposes, this code example writes an entry to the Event Viewer in debug mode only.

[!code-cppIUriKey#1]

The above code writes a new event to the Event Viewer, where the Data box contains XML that is similar to the following.

<cacheProvider>  
   <uriKey   
        siteId="1"   
        siteName=""   
        url="/DEFAULT.HTM"   
        cacheName="URI"   
        hash="12345678"   
        isEqual="true"   
        isPrefix="true" />  
</cacheProvider>

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.

Inheritance Hierarchy

IHttpCacheKey

IUriKey

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 Httpcach.h

See Also

Web Server Core Interfaces