| title | IHttpTokenKey::GetCacheName Method |
|---|---|
| description | This article contains information about syntax, return value, and requirements for the IHttpTokenKey::GetCacheName method. |
| ms.date | 10/07/2016 |
| ms.assetid | b3c94361-aaff-ccae-fb26-99db535f08fa |
Returns the name of the global token cache.
PCWSTR GetCacheName(
VOID
) const; This method takes no parameters.
A pointer to a constant null-terminated Unicode string that contains the name of the global token cache. The default is TOKEN_CACHE_NAME (described in IIS Caching Constants).
The cache name represents the unique name of the global cache where user data can be stored and retrieved.
IHttpTokenKey implementers are responsible for memory management with this data; therefore, IHttpTokenKey implementers that use dynamic memory allocation must release or call delete on the PCWSTR pointer when it is no longer needed.
Classes that directly implement the IHttpTokenKey interface should not override the default GetCacheName method, because the TOKEN_CACHE_NAME value instructs clients that are holding an IHttpCacheKey pointer that the pointer may be safely downcast to an IHttpTokenKey pointer.
IHttpTokenKey implementers are responsible for memory management with this data; therefore, IHttpTokenKey clients must not release or call delete on the returned PCWSTR pointer when this data is no longer needed. Furthermore, clients must not cast this data to a pointer that is not a const or change the state of the memory referenced by this PCWSTR; otherwise, an access violation will be thrown or the data will become invalid.
Interfaces that extend the IHttpTokenKey interface may override the GetCacheName method. However, the returned value must not collide with currently defined values, including those returned from the IHttpTokenKey::GetCacheName, IFileKey::GetCacheName, and IUriKey::GetCacheName methods.
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 GetCacheName 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-cppIHttpTokenKey#2]
The above code writes a new event to the Event Viewer, where the Data box contains a string that is similar to the following.
IHttpTokenKey::GetCacheName: TOKEN
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.
| 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 |